Système de substitution de variables

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search


Les variables de substitutions sont des mots clés qui peuvent être utilisés à de nombreux endroits dans Dolibarr pour être remplacés ultérieurement. On s'en sert par exemple dans les modèles d'emails ou de texte de configuration pour qu'un texte soit personnalisé au moment de son affichage ou de son envoi pour les emails.


Variables de substitution disponibles

Variable Valeur Affichée Note Dolibarr Mini
__USER_SIGNATURE__ Ma super signature Signature de l'utilisateur
__USER_ID__ 1 ID de l'utilisateur
__USER_LOGIN__ doli9 Login de l'utilisateur
__USER_LASTNAME__ Admin Nom de l'utilisateur
__USER_FIRSTNAME__ Super Prénom de l'utilisateur
__USER_FULLNAME__ SuperAdmin Nom complet de l'utilisateur
__USER_SUPERVISOR_ID__ 1 ID du superviseur
__USER_REMOTE_IP__ xxx.xxx.xxx.xxx IP de l'utilisateur
__MYCOMPANY_NAME__ Ma petite entreprise Nom de l'entreprise
__MYCOMPANY_EMAIL__ contact@monentreprise.fr Adresse email de contact de mon entreprise
__MYCOMPANY_PROFID1__ 12345678 Id. prof. 1 (TIN)
__MYCOMPANY_PROFID2__ 12345678 Id. prof. 2 (PAN)
__MYCOMPANY_PROFID3__ 12345678 Id. prof. 3 (SRVC TAX)
__MYCOMPANY_PROFID4__ 12345678 Id. prof. 4
__MYCOMPANY_PROFID5__ 12345678 Id. prof. 5
__MYCOMPANY_PROFID6__ FR12345678 Numéro de TVA
__MYCOMPANY_CAPITAL__ 10000 Capital de mon entreprise
__MYCOMPANY_FULLADDRESS__ 12 rue laurent 75001 Paris France Adresse complète de mon entreprise
__MYCOMPANY_ADDRESS__ 12 rue laurent Rue et numéro de rue de mon entreprise
__MYCOMPANY_ZIP__ 75001 Code postale de mon entreprise
__MYCOMPANY_TOWN__ Paris Ville de mon entreprise
__MYCOMPANY_COUNTRY__ France Pays de mon entreprise
__MYCOMPANY_COUNTRY_ID__ 1 Identifiant du pays de mon entreprise
__MYCOMPANY_CURRENCY_CODE__ EUR Devise principale de mon entreprise
__ID__ 1 ID de l'object
__REF__ 1234 Référence de l'objet
__REF_CLIENT__ 1234 Référence client de l'objet
__REF_SUPPLIER__ 1234 Référence fournisseur de l'objet
__EXTRAFIELD_XXX__ ????? Attribut supplémentaire de l'object (XXX doit être remplacé par le code de l'attribut)
__THIRDPARTY_ID__ 1 ID du tiers
__THIRDPARTY_NAME__ MonClient Nom du tiers
__THIRDPARTY_NAME_ALIAS__ MonC Alias du tiers
__THIRDPARTY_EMAIL__ contact@monclient.com Adresse email du tiers
__CONTACT_NAME_CUSTOMER__ civilité prénom nom Genre prénom et nom du contact de type 'contact suivi proposition' d'une proposition commerciale
__PROJECT_ID__ 1 ID du projet de l'objet
__PROJECT_REF__ 1234 Référence du projet de l'objet
__PROJECT_NAME__ MonProjet Nom du projet de l'objet
__CONTRACT_HIGHEST_PLANNED_START_DATE__ 01/01/2020 Date la plus tardive prévue pour le démarrage du contrat
__CONTRACT_HIGHEST_PLANNED_START_DATETIME__ 1/1/2020 13h Date et heure la plus tardive prévue pour le démarrage du contrat
__CONTRACT_LOWEST_EXPIRATION_DATE__ 01/01/2020 Date la plus proche pour l'expiration du contrat
__CONTRACT_LOWEST_EXPIRATION_DATETIME__ 1/1/2020 13h Date et heure la plus proche pour l'expiration du contrat
__ONLINE_PAYMENT_URL__ https://mondoli.com/payment Adresse du paiement en ligne (si applicable)
__ONLINE_PAYMENT_TEXT_AND_URL__ Cliquez pour payer Texte et adresse du paiement en ligne (si applicable)
__SECUREKEYPAYMENT__ Clé de sécurité pour le paiement (si la clé n'est pas unique par enregistrement)
__SECUREKEYPAYMENT_MEMBER__ Clé de sécurité pour le paiement de l'abonnement d'un membre (une clé par membre)
__SECUREKEYPAYMENT_ORDER__ Clé de sécurité pour le paiement d'une commande
__SECUREKEYPAYMENT_INVOICE__ Clé de sécurité pour le paiement d'une facture
__SECUREKEYPAYMENT_CONTRACTLINE__ Clé de sécurité pour le paiement d'un contrat
__DIRECTDOWNLOAD_URL_PROPOSAL__ https://mondoli.com/devis.pdf URL de téléchargement direct d'un devis
__DIRECTDOWNLOAD_URL_ORDER__ http://mondoli.com/commande.pdf URL de téléchargement direct d'une commande
__DIRECTDOWNLOAD_URL_INVOICE__ http://mondoli.com/facture.pdf URL de téléchargement direct d'une facture. Pour cela, il faut que le paramètre INVOICE_ALLOW_EXTERNAL_DOWNLOAD soit configuré pour permettre de générer le lien.
__SHIPPINGTRACKNUM__ XXXXX Numéro de suivi du colis
__SHIPPINGTRACKNUMURL__ http://trackingcompagny.com/XXXXX URL de suivi du colis
__DATE_YMD__ 01/01/2020 Date d'aujourd'hui
__DATE_DUE_YMD__ 01/01/2020 Date d'échéance
__AMOUNT__ -> 1243,34 Montant total
__AMOUNT_EXCL_TAX__ -> __AMOUNT_EXCL_TAX__ 1234,45 Montant total hors taxe
__AMOUNT_VAT__ -> __AMOUNT_VAT__ 123,4 Montant TVA
__AMOUNT_FORMATED__ 1243,34 € Montant total formaté
__AMOUNT_EXCL_TAX_FORMATED__ 1234,45 € Montant total hors taxe formaté
__AMOUNT_VAT_FORMATED__ -> __AMOUNT_VAT_FORMATED__ 123,4 € Montant TVA formaté
__DAY__ 12 Jours actuel (chiffre)
__DAY_TEXT__ Mardi Jours actuel (texte)
__DAY_TEXT_SHORT__ Ma Jours actuel en texte abrégé
__DAY_TEXT_MIN__ M Jours actuel en texte en une lettre
__MONTH__ 3 Mois actuel (chiffre)
__MONTH_TEXT__ Mars Mois actuel (texte)
__MONTH_TEXT_SHORT__ Ma. Mois actuel en texte abrégé
__MONTH_TEXT_MIN__ M Mois actuel en texte en une lettre
__YEAR__ 2020 Année actuelle
__PREVIOUS_DAY__ 11 Hier (chiffre)
__PREVIOUS_MONTH__ 2 Mois précédent (chiffre)
__PREVIOUS_YEAR__ 2019 Année précédente
__NEXT_DAY__ 13 Demain (chiffre)
__NEXT_MONTH__ 4 Mois prochain
__NEXT_YEAR__ 2021 Année prochaine
__DOL_MAIN_URL_ROOT__ http://mondolibarr.fr/htdocs Adresse de mon dolibarr
__(Clédetraduction)__ Clé traduite N'importe qu'elle clé de traduction
__[constante]__ Valeure de la constante N'importe qu'elle constante
__DATE_DELIVERY__ 21/09/1974 Date de livraison de la Propal V14
__CONTACT_NAME_XXX__ Mr T Civilité/titre prénom et nom du contact

XXX est le type de contact défini dans Accueil>configuration>dictionnaires>Types de contacts/adresses (par exemple : __CONTACT_NAME_BILLING__ pour le contact client désigné comme responsable de la facturation sur une facture)

__CONTACT_LASTNAME_XXX__ Nom patronymique du contact Nom du contact

XXX est le type de contact défini dans Accueil>configuration>dictionnaires>Types de contacts/adresses (par exemple : __CONTACT_NAME_BILLING__ pour le contact client désigné comme responsable de la facturation sur une facture)

__CONTACT_FIRSTNAME_XXX__ Prénom du contact Prénom du contact

XXX est le type de contact défini dans Accueil>configuration>dictionnaires>Types de contacts/adresses (par exemple : __CONTACT_NAME_BILLING__ pour le contact client désigné comme responsable de la facturation sur une facture)

__CONTACT_TITLE_XXX__ Titre de civilité du contact Titre/civilité du contact

XXX est le type de contact défini dans Accueil>configuration>dictionnaires>Types de contacts/adresses (par exemple : __CONTACT_NAME_BILLING__ pour le contact client désigné comme responsable de la facturation sur une facture)

__UNSUBSCRIBE__ Lien de désinscription

Variables de substitution Personnalisées de modules externes

Un module peut ajouter ses propres variables de substitutions. Pour cela, le module doit embarquer un fichier avec le nom monmodule/core/substitutions/functions_monmodule.lib.php et en définissant le

$this->module_parts['substitutions'] = 1

dans le descripteur de module.