Difference between revisions of "Substitution Variables"

From Tactic Wiki
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Introduction =   
= Introduction =   
Just as the word substitution suggests, substitution variables are the keywords that are used temporarily only to be replaced later on. For making it easy to understand, these keywords are used in the email templates or in configuration texts as examples. These act as the texts, which would be personalized automatically when an email is sent.  
Just as the word substitution suggests, substitution variables are the keywords that are used temporarily only to be replaced at the time of script execution on the fly. For making it easy to understand, these keywords are used in various automated tasks, which is to cut down your effort on manually incorporating data each time you need to send an email or create an invoice and so on. These act as the texts, which would be personalized automatically whenever a document is generated. To state in a simpler manner, substitution variables are the keywords that change dynamically with information from database, based on the task you have commanded Tactic to complete. However, please note that these variables are only a subject to be replaced if there is corresponding data in the object.
However, please note that these variables are only a subject to be replaced if there is corresponding data in the object.  
 
There are two types of substitution variables that you can put into work in Tactic.  
There are two types of substitution variables that you can put into work in Tactic.  


Line 32: Line 32:
| __USER_SUPERVISOR_ID__ || 1 || Supervisor ID of the user  
| __USER_SUPERVISOR_ID__ || 1 || Supervisor ID of the user  
|-
|-
| __USER_REMOTE_IP__ || 123.456.789.101 || Remote IP of the user  
| __USER_REMOTE_IP__ || 127.0.0.1 || Remote IP of the user  
|}
|}


Line 71: Line 71:
| __MYCOMPANY_COUNTRY_ID__ || 1 || Country ID of the company
| __MYCOMPANY_COUNTRY_ID__ || 1 || Country ID of the company
|-
|-
| __MYCOMPANY_COUNTRY_CODE__ || 1 || Country Code of the company
| __MYCOMPANY_COUNTRY_CODE__ || US || Country Code of the company
|-
|-
| __MYCOMPANY_CURRENCY_CODE__ || USD || Main currency that the company uses
| __MYCOMPANY_CURRENCY_CODE__ || USD || Main currency that the company uses
|}
|}
== Object ==  
== Object ==  
=== Generic ===
=== Generic ===

Latest revision as of 08:37, 21 November 2022

Introduction

Just as the word substitution suggests, substitution variables are the keywords that are used temporarily only to be replaced at the time of script execution on the fly. For making it easy to understand, these keywords are used in various automated tasks, which is to cut down your effort on manually incorporating data each time you need to send an email or create an invoice and so on. These act as the texts, which would be personalized automatically whenever a document is generated. To state in a simpler manner, substitution variables are the keywords that change dynamically with information from database, based on the task you have commanded Tactic to complete. However, please note that these variables are only a subject to be replaced if there is corresponding data in the object.

There are two types of substitution variables that you can put into work in Tactic.

1. Available substitution variables

2. Custom substitution variables

Both of the variable types are explained below,

Available substitution variables

You can find a set of available substitution variables in Tactic and the list of available variables are provided below.

Tactic User

Tactic user
Variable Displayed value Note
__USER_SIGNATURE__ My official signature Signature of the user
__USER_ID__ 1 ID of the user
__USER_LOGIN__ tactic01 Login of the user
__USER_LASTNAME__ Admin Last name of the user
__USER_FIRSTNAME__ Super First name of the user
__USER_FULLNAME__ Super Admin Full name of the user
__USER_SUPERVISOR_ID__ 1 Supervisor ID of the user
__USER_REMOTE_IP__ 127.0.0.1 Remote IP of the user

My company

My Company
Variable Displayed value Note
__MYCOMPANY_NAME__ My little company Name of the company
__MYCOMPANY_EMAIL__ support@mycompany.com Company’s email
__MYCOMPANY_PROFID1__ 12345678 Company’s profile ID 1
__MYCOMPANY_PROFID2__ 12345678 Company’s profile ID 2
__MYCOMPANY_PROFID3__ 12345678 Company’s profile ID 3
__MYCOMPANY_PROFID4__ 12345678 Company’s profile ID 4
__MYCOMPANY_PROFID5__ 12345678 Company’s profile ID 5
__MYCOMPANY_PROFID6__ 12345678 Company’s profile ID 6
__MYCOMPANY_CAPITAL__ 10000 Capital of the company
__MYCOMPANY_FULLADDRESS__ 1582 Hardesty Street, Albany, New York, 12207 Full address of the company
__MYCOMPANY_ADDRESS__ 1582 Hardesty Street Exact location of the company
__MYCOMPANY_ZIP__ 12207 Zip code of company’s location
__MYCOMPANY_TOWN__ Albany Town of the company
__MYCOMPANY_COUNTRY__ USA Country of the company
__MYCOMPANY_COUNTRY_ID__ 1 Country ID of the company
__MYCOMPANY_COUNTRY_CODE__ US Country Code of the company
__MYCOMPANY_CURRENCY_CODE__ USD Main currency that the company uses

Object

Generic

Generic objects
Variable Displayed Value Note
__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
__NOTE_PUBLIC__ My Public note Public Note associated with the object
__NOTE_PRIVATE__ My Private note Private Note associated with the object
__DATE_DELIVERY__ 01/01/2023 Delivery date

Objects with Amount

Objects with Amount
Variable Displayed Value Note
__DATE_YMD__ 1/1/2023 The current date
__DATE_DUE_YMD__ 1/1/2023 Due date
__AMOUNT__ 1243.56 Amount
__AMOUNT_TEXT__ One thousand five hundred ... Amount in words
__AMOUNT_TEXTCURRENCY__ One thousand five hundred ... Amount in words with currency
__AMOUNT_EXCL_TAX__ 1234.56 Amount without taxes
__AMOUNT_VAT__ 123.4 VAT amount
__AMOUNT_VAT_TEXT__ One thousand five hundred ... VAT Amount in words
__AMOUNT_VAT_TEXTCURRENCY__ One thousand five hundred ... VAT Amount in words with currency
__AMOUNT_TAX2__ 123.4 TAX2 amount
__AMOUNT_TAX3__ 123.4 TAX3 amount
__AMOUNT_FORMATED__ $1243.34 Formatted amount
__AMOUNT_EXCL_TAX_FORMATED__ $1234.45 Formatted amount without taxes
__AMOUNT_VAT_FORMATED__ $123.4 Formatted VAT amount
__AMOUNT_TAX2_FORMATED__ $123.4 Formatted TAX2 amount
__AMOUNT_TAX3_FORMATED__ $123.4 Formatted TAX3 amount
__AMOUNT_MULTICURRENCY__ €1234.45 Amount in Multicurrency
__AMOUNT_MULTICURRENCY_TEXT__ One thousand five hundred ... Amount in Multicurrency in words
__AMOUNT_MULTICURRENCY_TEXTCURRENCY__ One thousand five hundred ... Amount in Multicurrency in words with currency

Member

Member
Variable Displayed Value Note
__MEMBER_ID__ 123 The ID of the member
__MEMBER_CIVILITY__
__MEMBER_FIRSTNAME__ John (example) The first name of the member
__MEMBER_LASTNAME__ Brick (example) The last name of the member
__MEMBER_FULLNAME__ John Brick (example) The full name of the member
__MEMBER_COMPANY__ Brick Enterprise (example) The company name of the member
__MEMBER_ADDRESS__ 3876 Musgrave Street, Georgia, 30071 The address of the member
__MEMBER_ZIP__ 30071 The zip code of the member’s address
__MEMBER_TOWN__ Georgia The town in which the member resides
__MEMBER_COUNTRY__ USA The country in which the member resides
__MEMBER_EMAIL__ jb@example.com The email ID of the member
__MEMBER_BIRTH__ 1/1/1990 The birth date of the member
__MEMBER_PHOTO__ Photo Photo of the member
__MEMBER_LOGIN__ login The login ID of the member
__MEMBER_PASSWORD__ XXXXX Password of the member
__MEMBER_PHONE__ 1234567891 The phone number of the member
__MEMBER_PHONEPRO__ 1234567891 The professional phone number of the member
__MEMBER_PHONEMOBILE__ 1234567891 The mobile number of the member
__MEMBER_TYPE__ Type Member type assigned to the member
__MEMBER_FIRST_SUBSCRIPTION_DATE__ 1/1/2023 Member’s first subscription date
__MEMBER_FIRST_SUBSCRIPTION_DATE_START__ 1/1/2023 Start date of member’s first subscription
__MEMBER_FIRST_SUBSCRIPTION_DATE_END__ 1/1/2025 The end date of member’s first subscription
__MEMBER_LAST_SUBSCRIPTION_DATE__ 1/1/2023 Last subscription date of the member
__MEMBER_LAST_SUBSCRIPTION_DATE_START__ 1/1/2023 Start date of member’s last subscription
__MEMBER_LAST_SUBSCRIPTION_DATE_END__ 1/1/2025 End date of member’s last subscription

Third party

Third party
Variable Displayed Value Note
__THIRDPARTY_ID__ 1 ID of the third party
__THIRDPARTY_NAME__ MG company Name of the third party
__THIRDPARTY_NAME_ALIAS__ Lee King (example) Name of Alias of the third party
__THIRDPARTY_CODE_CLIENT__ 12345 Client code of the third party
__THIRDPARTY_CODE_FOURNISSEUR__ 678910 Supplier code of the third party
__THIRDPARTY_EMAIL__ contact@thirdparty.com Email of the third party
__THIRDPARTY_PHONE__ XXXXXXXXX Phone number of the third party
__THIRDPARTY_FAX__ XXXXXXXXXX Fax number of the third party
__THIRDPARTY_ADDRESS__ 2429 Rockford Mountain Lane, Wisconsin, 53151 Address of the third party
__THIRDPARTY_ZIP__ 53151 Zip code of the third party
__THIRDPARTY_TOWN__ Wisconsin Town of the third party
__THIRDPARTY_COUNTRY_ID__ US Country ID of the third party
__THIRDPARTY_COUNTRY_CODE__ 1 Country code of the third party
__THIRDPARTY_IDPROF1__ ID proof 1 Third party proof ID 1
__THIRDPARTY_IDPROF2__ ID proof 2 Third party proof ID 2
__THIRDPARTY_IDPROF3__ ID proof 3 Third party proof ID 3
__THIRDPARTY_IDPROF4__ ID proof 4 Third party proof ID 4
__THIRDPARTY_IDPROF5__ ID proof 5 Third party proof ID 5
__THIRDPARTY_IDPROF6__ ID proof 6 Third party proof ID 6
__THIRDPARTY_TVAINTRA__
__THIRDPARTY_NOTE_PUBLIC__ Important third party (example) Public notes regarding the concerned third party
__THIRDPARTY_NOTE_PRIVATE__ Very important third party (example) Private note regarding the concerned third party

Candidate

Candidate
Variable Displayed Value Note
__CANDIDATE_FULLNAME__ Amy White (example) Full name of the candidate
__CANDIDATE_FIRSTNAME__ Amy (example) First name of the candidate
__CANDIDATE_LASTNAME__ White (example) Last name of the candidate

Project

Project
Variable Displayed Value Note
__PROJECT_ID__ 1 ID of the project
__PROJECT_REF__ 1 Reference number of the project
__PROJECT_NAME__ Project A Name of the project

Shipment

Candidate
Variable Displayed Value Note
__SHIPPINGTRACKNUM__ XXXXX Shipping tacking number
__SHIPPINGTRACKNUMURL__ http://trackingcompagny.com/XXXXX Shipping tracking URL

Reception

Reception
Variable Displayed Value Note
__RECEPTIONTRACKNUM__ XXXXX Reception tacking number
__RECEPTIONTRACKNUMURL__ http://trackingcompagny.com/XXXXX Reception tracking URL

Contract

Contact
Variable Displayed Value Note
__CONTRACT_HIGHEST_PLANNED_START_DATE__ 1/1/2023 Highest date planned for the start of a service
__CONTRACT_HIGHEST_PLANNED_START_DATETIME__ 1/1/2023 1PM Highest date and hour planned the start of a service
__CONTRACT_LOWEST_EXPIRATION_DATE__ 1/1/2024 Lowest date planned for the expiration of a service
__CONTRACT_LOWEST_EXPIRATION_DATETIME__ 1/1/2024 1PM Lowest date and hour planned for the expiration of a service

Extrafield

Generic Rule

Generic rule
Variable Displayed Value Note
__EXTRAFIELD_XXX__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code

Date Extrafield

Date Extrafield
Variable Displayed Value Note
__EXTRAFIELD_XXX__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code
__EXTRAFIELD_XXX_LOCALE__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code in locale
__EXTRAFIELD_XXX_RFC__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code in RFC

Datetime Extrafield

Datetime Extrafield
Variable Displayed Value Note
__EXTRAFIELD_XXX__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code
__EXTRAFIELD_XXX_LOCALE__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code in locale
__EXTRAFIELD_XXX_DAY_LOCALE__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code only the day in locale
__EXTRAFIELD_XXX_RFC__ Extrafield object, in which XXX need to be replace by the Extrafield Attribute code in RFC

Online Proposal Signature

Online proposal signature
Variable Displayed Value Note
__ONLINE_SIGN_URL__ http://tacticdemo.com/public/onlinesign Address of the Online Signature for proposal

Document download

Document download
Variable Displayed Value Note
__DIRECTDOWNLOAD_URL_PROPOSAL__ http://tacticdemo.com/proposal.pdf Direct download URL of a proposal
__DIRECTDOWNLOAD_URL_ORDER__ http:// tacticdemo.com/order.pdf Direct download URL of an order
__DIRECTDOWNLOAD_URL_INVOICE__ http:// tacticdemo.com/invoice.pdf This is a Direct download URL of an invoice. However, this needs that the setup INVOICE_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.
__URL_PROPOSAL__ http:// tacticdemo.com/comm/propal/card.php?id=xxx A direct link to the concerned proposal
__URL_ORDER__ http:// tacticdemo.com/commande/card.php?id=xxxx A direct link to the concerned order
__URL_INVOICE__ http:// tacticdemo.com/compta/facture/card.php?id=xxx This is a direct download URL of an invoice. However, this needs that the setup INVOICE_ALLOW_EXTERNAL_DOWNLOAD is set to allow to generate the link.

Event

Event
Variable Displayed Value Note
__EVENT_LABEL__ Important meeting (example) The label of the event
__EVENT_DATE__ 1/1/2023 The date of the event
__EVENT_TIME__ 1 PM The time of the event

Dates

Dates
Variable Displayed Value Note
__DAY__ 12 The current date
__DAY_TEXT__ Monday Current day in text
__DAY_TEXT_SHORT__ Mo Current day in short text
__DAY_TEXT_MIN__ M Current day in minimum text
__MONTH__ 3 Current month
__MONTH_TEXT__ March Current month in text
__MONTH_TEXT_SHORT__ March Current month in short text
__MONTH_TEXT_MIN__ M Current month in minimum text
__YEAR__ 2023__ 2023 Current year
__PREVIOUS_DAY__ 11 Previous day
__PREVIOUS_MONTH__ 2 Previous month
__PREVIOUS_YEAR__ 2022 Previous Year
__NEXT_DAY__ 13 Next day
__NEXT_MONTH__ 4 Next month
__NEXT_YEAR__ 2024 next year

Multicompany

Multicompany
Variable Displayed Value Note
__ENTITY_ID__ 123 The entity ID for multicompany

System

System
Variable Displayed Value Note
__TIC_MAIN_URL_ROOT__ http://montactic/htdocs Root URL of Tactic
__(AnyTranslationKey)__ Translation Translation key of any sort
__(AnyTranslationKeylangfile)__ Translation Translation key of any sort, while loading language file before.
__[AnyConstantKey]__ 1 Value of a constant key

For Emails

Emails
Variable Displayed Value Note
__CONTACT_NAME_XXX__ Mr A Here, XXX is the contact type defined on Setup->Dictionaries->Contact/Address types (exemple: __CONTACT_NAME_BILLING__ for the billing contact). The output will be Title + LastName + First Name
__CHECK_READ__ Image Insert a blank image with a callback URL to Tactic (/public/emailing/mailing-read.php?tag=)

Custom Substitution Variables

The users can add custom substitution variables by adding external modules.

Retrieved from "http://tactic-wiki.alsoft.org/index.php?title=Substitution_Variables&oldid=2964"