Variable substitution system

From Dolibarr ERP CRM Wiki
Revision as of 13:16, 12 August 2019 by Eldy (talk | contribs) (Created page with "{{TemplateDocUser}} {{TemplateDocDevEn}} Substitution variables are keywords that can be used in many places in Dolibarr to be replaced later. It is used for example in the t...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Substitution variables are keywords that can be used in many places in Dolibarr to be replaced later. It is used for example in the templates of emails or configuration text for a text to be personalized when it is displayed or sent for emails.


Substitution variables available

Variable Valeur Affichée Dolibarr Mini Note
__USER_SIGNATURE__ USERSIGNATURE
__USER_ID__ -> 1 1
__USER_LOGIN__ doli9
__USER_LASTNAME__ SuperAdmin
__USER_FIRSTNAME__ -> __USER_FIRSTNAME__
__USER_FULLNAME__ -> SuperAdmin
__USER_SUPERVISOR_ID__ -> __USER_SUPERVISOR_ID__
__USER_REMOTE_IP__ -> xxx.xxx.xxx.xxx
__MYCOMPANY_NAME__ -> Nom
__MYCOMPANY_EMAIL__ -> __MYCOMPANY_EMAIL__
__MYCOMPANY_PROFID1__ -> __MYCOMPANY_PROFID1__
__MYCOMPANY_PROFID2__ -> __MYCOMPANY_PROFID2__
__MYCOMPANY_PROFID3__ -> __MYCOMPANY_PROFID3__
__MYCOMPANY_PROFID4__ -> __MYCOMPANY_PROFID4__
__MYCOMPANY_PROFID5__ -> __MYCOMPANY_PROFID5__
__MYCOMPANY_PROFID6__ -> __MYCOMPANY_PROFID6__
__MYCOMPANY_CAPITAL__ -> __MYCOMPANY_CAPITAL__
__MYCOMPANY_FULLADDRESS__ -> France
__MYCOMPANY_ADDRESS__ -> __MYCOMPANY_ADDRESS__
__MYCOMPANY_ZIP__ -> __MYCOMPANY_ZIP__
__MYCOMPANY_TOWN__ -> __MYCOMPANY_TOWN__
__MYCOMPANY_COUNTRY__ -> France
__MYCOMPANY_COUNTRY_ID__ -> 1
__MYCOMPANY_CURRENCY_CODE__ -> EUR
__ID__ -> __ID__
__REF__ -> __REF__
__REF_CLIENT__ -> __REF_CLIENT__
__REF_SUPPLIER__ -> __REF_SUPPLIER__
__EXTRAFIELD_XXX__ -> __EXTRAFIELD_XXX__
__THIRDPARTY_ID__ -> __THIRDPARTY_ID__
__THIRDPARTY_NAME__ -> __THIRDPARTY_NAME__
__THIRDPARTY_NAME_ALIAS__ -> __THIRDPARTY_NAME_ALIAS__
__THIRDPARTY_EMAIL__ -> __THIRDPARTY_EMAIL__
__PROJECT_ID__ -> __PROJECT_ID__
__PROJECT_REF__ -> __PROJECT_REF__
__PROJECT_NAME__ -> __PROJECT_NAME__
__CONTRACT_HIGHEST_PLANNED_START_DATE__ -> Highest date planned for a service start
__CONTRACT_HIGHEST_PLANNED_START_DATETIME__ -> Highest date and hour planned for service start
__CONTRACT_LOWEST_EXPIRATION_DATE__ -> Lowest data for planned expiration of service
__CONTRACT_LOWEST_EXPIRATION_DATETIME__ -> Lowest date and hour for planned expiration of service
__ONLINE_PAYMENT_URL__ -> UrlToPayOnlineIfApplicable
__ONLINE_PAYMENT_TEXT_AND_URL__ -> TextAndUrlToPayOnlineIfApplicable
__SECUREKEYPAYMENT__ -> Security key (if key is not unique per record)
__SECUREKEYPAYMENT_MEMBER__ -> Security key for payment on a member subscription (one key per member)
__SECUREKEYPAYMENT_ORDER__ -> Security key for payment on an order
  • __SECUREKEYPAYMENT_INVOICE__ -> Security key for payment on an invoice
__SECUREKEYPAYMENT_CONTRACTLINE__ -> Security key for payment on a a service
__DIRECTDOWNLOAD_URL_PROPOSAL__ -> Direct download url of a proposal
__DIRECTDOWNLOAD_URL_ORDER__ -> Direct download url of an order
__DIRECTDOWNLOAD_URL_INVOICE__ -> Direct download url of an invoice. This needs that the setup INVOICE_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.
__SHIPPINGTRACKNUM__ -> Shipping tacking number
__SHIPPINGTRACKNUMURL__ -> Shipping tracking url
__DATE_YMD__ -> __DATE_YMD__
__DATE_DUE_YMD__ -> __DATE_DUE_YMD__
__AMOUNT__ -> __AMOUNT__
__AMOUNT_EXCL_TAX__ -> __AMOUNT_EXCL_TAX__
__AMOUNT_VAT__ -> __AMOUNT_VAT__
__AMOUNT_FORMATED__ -> __AMOUNT_FORMATED__
__AMOUNT_EXCL_TAX_FORMATED__ -> __AMOUNT_EXCL_TAX_FORMATED__
__AMOUNT_VAT_FORMATED__ -> __AMOUNT_VAT_FORMATED__
__DAY__ -> 12
__DAY_TEXT__ -> Mardi
__DAY_TEXT_SHORT__ -> Ma
__DAY_TEXT_MIN__ -> M
__MONTH__ -> 3
__MONTH_TEXT__ -> Mars
__MONTH_TEXT_SHORT__ -> Mars
__MONTH_TEXT_MIN__ -> M
__YEAR__ -> 2019
__PREVIOUS_DAY__ -> 11
__PREVIOUS_MONTH__ -> 2
__PREVIOUS_YEAR__ -> 2018
__NEXT_DAY__ -> 13
__NEXT_MONTH__ -> 4
__NEXT_YEAR__ -> 2020
__(AnyTranslationKey)__ -> Translation
__[AnyConstantKey]__ -> Valeur de constante
__CONTACT_NAME_XXX__ -> XXX est le type de contact défini dans Accueil>configuration>dictionnaires>Types de contacts/adresses (par exemple : __CONTACT_NAME_BILING__ pour le contact client désigné comme responsable de la facturation sur une facture) Contient Titre+Nom+Prénom

Custom substitution variables