View source for Mailshot Configuration - Accounts Document


{{Information|text=
It should be noted that these mailshot letters via these token files are supported for historic purposes and have been replaced by the {{Menu|{{Menu|Reports & Settings}}|Account Mailshots}} option which uses the {{Menu|Report Generator}} for producing mailshots.
}}

== Tokens ==
=== General Tokens ===
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~1'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 1'''
|- valign="baseline"
| '''~2'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 2'''
|- valign="baseline"
| '''~3'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 3'''
|- valign="baseline"
| '''~4'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 4'''
|- valign="baseline"
| '''~5'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line 5'''
|- valign="baseline"
| '''~6'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Company Name'''
|- valign="baseline"
| '''~7''',n
| '''Telephone Number'''
;n = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>Telephone Number.
;n = 1
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>Mobile Number.
|- valign="baseline"
| '''~8'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Fax Number'''
|- valign="baseline"
| '''~9'''
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Account Balance'''
|- valign="baseline"
| '''~10'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Credit Limit'''
|- valign="baseline"
| '''~11'''
| <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Discount Percentage'''
|- valign="baseline"
| '''~12'''
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Settlement Period'''
|- valign="baseline"
| '''~13'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Customer Code'''
|- valign="baseline"
| '''~14'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''User Date'''
|- valign="baseline"
| '''~15'''
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Account Notes Line 1'''
|- valign="baseline"
| '''~15'''
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Account Notes Line 2'''
|- valign="baseline"
| '''~17'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Account Reference'''
|- valign="baseline"
| '''~18''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Contact Name'''
;n = 1 -> 10
:The contact name index.
|- valign="baseline"
| '''~40'''
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Your Company Name - Line 1'''
|- valign="baseline"
| '''~41'''
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Your Company Name - Line 2'''
|- valign="baseline"
| '''~42'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Your Company Address - Line 1'''
|- valign="baseline"
| '''~43'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Your Company Address - Line 2'''
|- valign="baseline"
| '''~44'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Your Company Address - Line 3'''
|- valign="baseline"
| '''~45'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Your Company Address - Line 4'''
|- valign="baseline"
| '''~46'''
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Your Company Address - Line 5'''
|- valign="baseline"
| '''~75''',n,m,l
| '''Form Length'''
{{Note|iconsize=small|text=
This code must be on it's own line, as everything else on a line that has this token will be ignored.
}}

;n
:Current line number.
;m
:Form Length.
;l
:Form Break.
|- valign="baseline"
| '''~76'''
| '''Form Feed'''
{{Note|iconsize=small|text=
This code must be on it's own line, as everything else on a line that has this token will be ignored.
}}

|- valign="baseline"
| '''~89'''
| '''Space Compression'''
Turn space compression on and off (default). Multiple spaces on a line will be compressed down into one space.
|}
=== Currency Conversions ===
{{Information|text=
''Platinum'' "Elite" systems only. "Solo" systems will need to be upgraded to "Elite", contact your ''Platinum'' dealer or our sales team on (0116) 230 1500 or by using our [https://www.catalyst-uk.com/sales website] sales contact page for your upgrade path.
}}

All tokens that return a currency amount may now be modified to convert that amount into a different currency before printing. This is done by using a currency modifier after the token number but before any parameters. This modifier begins with a special symbol and may optionally be followed by a number and/or a three character currency code.

To get the relevant currency symbol to print on a document, the symbols '$' and '#' (hash symbol, but may have been misprinted as a pound sign) are used immediately after the token that you wish the currency conversion to take place. Using the '#' will suppress the printing of the currency symbol. This can be useful when printers don't have relevant symbols for some currencies.

{{Note|text=
Unless the relevant currency required is set up against the base rate in Currency Maintenance, no conversion will take place. Also, the customer needs to be correctly flagged for the appropriate Country.
}}

The number part of the modifier may be used to specify the maximum number of characters to print. Some currencies may involve quite large amounts and this number can be used to make sure there is enough room to print them. The three character currency code specifies which currency to convert the amount to. This may be omitted, in which case the currency specified for the account associated with the document being printed will be used, if there is one.

{{Example|text=
Some examples using {{DataValue|~29,1}} amount taxed at tax rate 1. Note that {{DataValue|~29}} may not represent an amount in all document formats. This is just an example.

;~29,1
:no conversion
:{{DataValue|*100.00}} - (where * is your usual currency symbol).
;~29$,1
:convert to the account currency (if there is one)
:{{DataValue|1005.18F}} - (e.g. French Francs.)
;~29$12,1
:convert to account currency and print to a width of 12
:{{DataValue|1005.18F}}
;~29$USD,1
:convert to currency USD (US Dollar)
:{{DataValue|$234.02}}
;~29$USD(02),1
:convert to currency USD (US Dollar) and target to whole dollar units if within 2 cents. This feature is useful if you want to display values with the cents/pennies rounded away. For example if displaying in dollars then the number in brackets represents the maximum number of cents over or under a dollar within which the conversion will target to a whole dollar. For 02 within the brackets then $1.98, $1.99, $2.00, $2.01, $2.02 will all display as $2.00.
:{{DataValue|$234.00}}
;~29#12USD,1
:same, but suppress the symbol and print to a width of 12
:{{DataValue|234.56}}
}}

==== Currency Configuration ====
There is an optional Currency Conversion configuration token which when used should be placed in the Configuration block. This token may have a currency modifier applied to it which will then be used by default throughout the document, although it can be overridden by modifiers applied to individual tokens.

{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~198x'''
| '''x = Default currency modifier (optional)'''
|}
==== Country/Currency Tokens ====
There is a group of tokens that may be used in headers and footers to print details about the country and currency set up for the account associated with the document.

{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~292''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Country code/description for the document.'''
If the account in use has a specific country associated with it this will be used, otherwise the system default country will be output.
;n = 0
:Output the country code.
;n = 1
:<div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>Output the country description.
|- valign="baseline"
| '''~293'''
| <div style="float:right; margin-left:1em; font-style:italic;">(12 characters)</div>'''Exchange rate from base currency to account currency'''
|- valign="baseline"
| '''~294'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Sub-units of the currency set for this account'''
|- valign="baseline"
| '''~295'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Units of the currency set for this account'''
|- valign="baseline"
| '''~296'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Name of the currency set for this account'''
|- valign="baseline"
| '''~297'''
| <div style="float:right; margin-left:1em; font-style:italic;">(3 characters)</div>'''Code of the currency set for this account'''
|- valign="baseline"
| '''~298'''
| '''Skip block until next ~298'''
Should be used in pairs on a line. Everything between them is blanked out if there is no currency set for this account
|}[[Category:Documents]][[Category:Accounts Documents]]