Variable substitution system
Revision as of 14:50, 19 February 2020 by Framaurin (talk | contribs) (→Substitution variables available)
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 | Displayed Value | Dolibarr Mini | Note |
|---|---|---|---|
| __USER_SIGNATURE__ | My beautiful signature | User signature | |
| __USER_ID__ | 1 | User ID | |
| __USER_LOGIN__ | doli9 | User Login | |
| __USER_LASTNAME__ | Admin | User last name | |
| __USER_FIRSTNAME__ | Super | User first name | |
| __USER_FULLNAME__ | SuperAdmin | User full name | |
| __USER_SUPERVISOR_ID__ | 1 | User supervisor ID | |
| __USER_REMOTE_IP__ | xxx.xxx.xxx.xxx | User remote IP | |
| __MYCOMPANY_NAME__ | My little company | Name of the company | |
| __MYCOMPANY_EMAIL__ | contact@mycompany.com | My company contact email | |
| __MYCOMPANY_PROFID1__ | 12345678 | Prof Id 1 (TIN) | |
| __MYCOMPANY_PROFID2__ | 12345678 | Prof Id 2 (PAN) | |
| __MYCOMPANY_PROFID3__ | 12345678 | Prof Id 3 (SRVC TAX) | |
| __MYCOMPANY_PROFID4__ | 12345678 | Prof Id 4 | |
| __MYCOMPANY_PROFID5__ | 12345678 | Prof Id 5 | |
| __MYCOMPANY_PROFID6__ | 12345678 | VAT ID | |
| __MYCOMPANY_CAPITAL__ | 10000 | Capital of the company | |
| __MYCOMPANY_FULLADDRESS__ | 21 Jump street 75500 MyTown India | Full address of the company | |
| __MYCOMPANY_ADDRESS__ | 21 Jump street | address of the company | |
| __MYCOMPANY_ZIP__ | 75500 | ZIP code of the company address | |
| __MYCOMPANY_TOWN__ | MyTown | Town of the company address | |
| __MYCOMPANY_COUNTRY__ | India | Country of the company address | |
| __MYCOMPANY_COUNTRY_ID__ | 1 | Country ID of the company address | |
| __MYCOMPANY_CURRENCY_CODE__ | EUR | Main currency | |
| __ID__ | 1 | ID of the object | |
| __REF__ | 1234 | Reference of the object | |
| __REF_CLIENT__ | 1234 | Customer reference of the object | |
| __REF_SUPPLIER__ | 1234 | Supplier reference of the object | |
| __EXTRAFIELD_XXX__ | Object Extrafield (XXX need to be replace by the Extrafield Attribute code) | ||
| __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__ | Monday | ||
| __DAY_TEXT_SHORT__ | Mo | ||
| __DAY_TEXT_MIN__ | M | ||
| __MONTH__ | 3 | ||
| __MONTH_TEXT__ | March | ||
| __MONTH_TEXT_SHORT__ | March | ||
| __MONTH_TEXT_MIN__ | M | ||
| __YEAR__ | 2020 | ||
| __PREVIOUS_DAY__ | 11 | ||
| __PREVIOUS_MONTH__ | 2 | ||
| __PREVIOUS_YEAR__ | 2018 | ||
| __NEXT_DAY__ | 13 | ||
| __NEXT_MONTH__ | 4 | ||
| __NEXT_YEAR__ | 2021 | ||
|
http://mondolibarr/htdocs | ||
| __(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 | ||