View source for Receipts Configuration - Unit Sales Document


The Platinum System allows the layout of Receipts to be configured to print the details you require. This is done using a system of "tokens" which represent the items you wish to print, and their positions on the Invoice.

== Layout Data File Names ==
The layout files are stored in the {{FilePath|SXCo1\Docs}} folder, (or {{FilePath|SXCo2}}, {{FilePath|SXCo3}}, etc).

=== Receipts ===
;{{FilePath|VS_PLA.REC}}
:Plain Paper Receipt
== Token File Names ==
These are copied down into the main data directory when they are needed for the first time by Platinum, and from that point the layouts are as follows:

;{{FilePath|SXVS046.EPL}}
:Receipts
== Layout Tokens ==
Tokens are indicated by the character {{DataValue|<nowiki>~</nowiki>}} followed by a number (the token identifier).

These identifiers may be up to 3 digits in length in the range 1 to 999. Tokens each have specific uses, which are listed below.

=== Parameters ===
Some tokens may also be given parameters. The number of parameters vary for each token. To specify a token with parameters the token must be followed by a comma then parameter. Each parameter is similarly divided from the next by a comma (no terminating comma is required).

== Document Areas ==
For the purposes of configuration, the document layouts are divided into 3 main areas: {{DataPrompt|Headings}}, {{DataPrompt|Body}} & {{DataPrompt|Footings}}.

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

|- valign="baseline"
| '''~100'''
| '''Configuration Section Start'''
|- valign="baseline"
| '''~199'''
| '''Configuration Section End'''
|- valign="baseline"
| '''~200'''
| '''Heading Block (First Page) Start'''
|- valign="baseline"
| '''~299'''
| '''Heading Block (First Page) End'''
|- valign="baseline"
| '''~300'''
| '''Heading Block (Continuation) Start'''
|- valign="baseline"
| '''~399'''
| '''Heading Block (Continuation) End'''
|- valign="baseline"
| '''~400'''
| '''Footing Block (Continuation) Start'''
|- valign="baseline"
| '''~499'''
| '''Footing Block (Continuation) End'''
|- valign="baseline"
| '''~500'''
| '''Footing Block (Last Page) Start'''
|- valign="baseline"
| '''~599'''
| '''Footing Block (Last Page) End'''
|}
== Tokens ==
=== General Tokens ===
These can appear in either Headers or Footers.

{| 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 Name'''
|- valign="baseline"
| '''~2''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Account Address Line'''
;n = 1 -> 5
:The line of the address.
|- valign="baseline"
| '''~3'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Account Code'''
|- valign="baseline"
| '''~4''',n
| '''Telephone Number/Email Address'''
;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.
;n = 2
:<div style="float:right; margin-left:1em; font-style:italic;">(60 characters)</div>Email Address.
|- valign="baseline"
| '''~5'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Fax Number'''
|- valign="baseline"
| '''~6''',n,m
| '''Account Notes Line'''
;n = 1 -> 5
:The line of the notes.
;m = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>Print Notes information.
;m = 1
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Print Notes prompt.
|- valign="baseline"
| '''~8''',n
| '''User Date'''
;n = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
;n = 1
:<div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
|- valign="baseline"
| '''~9''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Document Number'''
;n = 0
:Print in all cases.
;n = 1
:Blank if not in Heading.
|- valign="baseline"
| '''~10''',n
| '''Document Date'''
;n = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>Short format. e.g. {{DataValue|DD/MM/CCYY}}.
;n = 1
:<div style="float:right; margin-left:1em; font-style:italic;">(32 characters)</div>Long Format. e.g. {{DataValue|Friday, 31st January 20??}}.
|- valign="baseline"
| '''~11''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Company Name'''
;n = 1 -> 2
:The line of the name.
|- valign="baseline"
| '''~12''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(50 characters)</div>'''Company Address'''
;n = 1 -> 5
:The line of the address.
|- valign="baseline"
| '''~13''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(one line)</div>'''Heading Line'''
;n = 1 -> 2
:Heading text.
|- valign="baseline"
| '''~14''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(one line)</div>'''Footing Line'''
;n = 1 -> 3
:Footing text.
|- valign="baseline"
| '''~15'''
| <div style="float:right; margin-left:1em; font-style:italic;">(11 characters)</div>'''Heading Document Type'''
|- valign="baseline"
| '''~25'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Total : Amount Paid'''
|- valign="baseline"
| '''~33'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Account Group'''
|- valign="baseline"
| '''~34'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''System Parameters word for distance.'''
e.g. "Mileage" or "Kilometers"
|- valign="baseline"
| '''~45'''
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Sale Unit Warranty Number'''
|- valign="baseline"
| '''~47''',n
| '''Unit Make/Model'''
;n = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>First 20 characters of the description (legacy layouts).
;n = 1-4
:<div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>Line 1 - 4 of the description
|- valign="baseline"
| '''~48'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Unit Registration Number'''
|- valign="baseline"
| '''~49'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Unit V.I.N. Number'''
|- valign="baseline"
| '''~50'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Unit Engine Number'''
|- valign="baseline"
| '''~52''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Unit Distance'''
;n = 0
:Print spaces when zero.
;n = 1
:Print {{DataValue|0}} when zero.
|- valign="baseline"
| '''~54'''
| '''Slip Print Form Feed'''
|- valign="baseline"
| '''~55'''
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Part Exchange Unit Mileage'''
|- valign="baseline"
| '''~56'''
| <div style="float:right; margin-left:1em; font-style:italic;">(25 characters)</div>'''Part Exchange Unit Chassis Number'''
|- valign="baseline"
| '''~61'''
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''User/Group Name'''
|- valign="baseline"
| '''~62'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''Unit Colour'''
|- valign="baseline"
| '''~63'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Unit Chassis Number'''
|- valign="baseline"
| '''~211'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Account Reference'''
|- valign="baseline"
| '''~212'''
| <div style="float:right; margin-left:1em; font-style:italic;">(8 characters)</div>'''Unit Stock Number'''
|- valign="baseline"
| '''~213''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(1 character)</div>'''Account Analysis Code'''
;n = 1 -> 9
:Analysis Code index.
|- valign="baseline"
| '''~214''',n,m
| '''Account Analysis Description'''
;n = 1 -> 9
:Analysis Description index.
;m = 0
:<div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>First 15 characters of description.
;m = >0
:<div style="float:right; margin-left:1em; font-style:italic;">(Up to 30)</div>The full description.
|- valign="baseline"
| '''~215''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(60 characters)</div>'''Account Extra Notes'''
;n = 1 -> 999
:Account Extra Note line index.
|- valign="baseline"
| '''~216'''
| '''Skip block until next ~216'''
Print Spaces if a Credit Card Transaction is not involved.
|- valign="baseline"
| '''~217'''
| <div style="float:right; margin-left:1em; font-style:italic;">(30 characters)</div>'''Credit Card Holder Name'''
|- valign="baseline"
| '''~218'''
| <div style="float:right; margin-left:1em; font-style:italic;">(20 characters)</div>'''Credit Card Number'''
|- valign="baseline"
| '''~219'''
| <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Credit Card Expiry Date, as MM/YY'''
|- valign="baseline"
| '''~220'''
| <div style="float:right; margin-left:1em; font-style:italic;">(10 characters)</div>'''Credit Card Authorisation Code'''
|- valign="baseline"
| '''~221'''
| <div style="float:right; margin-left:1em; font-style:italic;">(2 characters)</div>'''Credit Card Issue Number'''
|- valign="baseline"
| '''~222'''
| <div style="float:right; margin-left:1em; font-style:italic;">(5 characters)</div>'''Credit Card Valid From Date, as MM/YY'''
|- valign="baseline"
| '''~223'''
| <div style="float:right; margin-left:1em; font-style:italic;">(15 characters)</div>'''System Merchant Number'''
|- valign="baseline"
| '''~224''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(40 characters)</div>'''Payment Description line'''
;n = 1
:Payment index
|}
=== Configuration Tokens ===
These affect the overall layout of the Invoice, and should be grouped together at the head of the layout file.

==== Document Blocks ====
The block information can either be supplied by you, in which case you should leave the parameters blank to begin with, and fill the values in when you are happy with the rest of the file; or the compiler can track the values down itself, which will marginally slow down the compilation process.

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

|- valign="baseline"
| '''~101''',n,m
| '''1st Page Heading Block'''
;n
:Start Line (i.e. Line for {{DataValue|~200}}).
;m
:End Line (i.e. Line for {{DataValue|~299}}).
|- valign="baseline"
| '''~102''',n,m
| '''Continuation Page Heading Block'''
;n
:Start Line (i.e. Line for {{DataValue|~300}}).
;m
:End Line (i.e. Line for {{DataValue|~399}}).
|- valign="baseline"
| '''~103''',n,m
| '''Continued Page Footing Block'''
;n
:Start Line (i.e. Line for {{DataValue|~400}}).
;m
:End Line (i.e. Line for {{DataValue|~499}}).
|- valign="baseline"
| '''~104''',n,m
| '''Final Page Footing Block'''
;n
:Start Line (i.e. Line for {{DataValue|~500}}).
;m
:End Line (i.e. Line for {{DataValue|~599}}).
|}
==== Document Configuration ====
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~109''',n
| '''Normal and Slip Body Style'''
;n = 0
:Standard.
;n = 1
:Condensed.
|- valign="baseline"
| '''~111''',n
| '''Line Skip'''
;n = 0
:No Line Skip.
;n = 1
:Line Skip between Items.
|- valign="baseline"
| '''~112''',n
| '''Heading Block'''
;n => 1
:The line to start printing.
|- valign="baseline"
| '''~113''',n,m
| '''Body Block'''
;n
:The line to start printing.
;m
:Depth (Number of lines to print).
|- valign="baseline"
| '''~114''',n
| '''Footing Block'''
;n
:The line to start printing.
|- valign="baseline"
| '''~115''',n
| '''Form Length'''
;n
:Number of Lines per Page.
|- valign="baseline"
| '''~119'''
| '''Stops V.A.T. Inclusive Invoices printing Tax & Grand Totals'''
Stops "V.A.T. Inclusive" Invoices printing Tax & Grand Total items in the {{DataValue|~700}} -> {{DataValue|~799}} Totals Block, as these can look confusing.

If a Blanket Discount applies, Grand Total will still be printed to reflect this.

|- valign="baseline"
| '''~198'''
| '''Currency conversion configuration'''
*See Currency Conversions at the end of this article for more details.
|}
=== Print Style Tokens ===
The following print style codes must have 3 spaces after them as these codes always 6 characters wide.
{| cellspacing="5" width="95%" valign="baseline"
!width="15%"|
!|
!|

|- valign="baseline"
| '''~79'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Expand'''
|- valign="baseline"
| '''~80'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Unexpand'''
|- valign="baseline"
| '''~81'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Compact'''
|- valign="baseline"
| '''~82'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Uncompact'''
|- valign="baseline"
| '''~83'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Double Strike On'''
|- valign="baseline"
| '''~84'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Double Strike Off'''
|- valign="baseline"
| '''~86'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Paper Forward'''
|- valign="baseline"
| '''~87'''
| <div style="float:right; margin-left:1em; font-style:italic;">(6 characters)</div>'''Paper Backward'''
|- valign="baseline"
| '''~88''',n
| <div style="float:right; margin-left:1em; font-style:italic;">(up to 32 characters)</div>'''Insert print style'''
This print style code doesn't need any spaces after it as it will the width of the print code to insert.
;n = 1 -> 999
:Corresponds to the print code ID in the "Print Code Amendments".
|}
=== 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
|}
{{KB_Tags|vehicle, unit, wholegood, caravan, agricultural machine, tractor, trailer, car, suv, motorcycle, motorbike, truck, van, lorry, motorhome, quad, atv, boat, tricycle, quadricycle, bicycle, bike, plant, Layout, Token, Format, Document, Setup, Config, Configuration, Receipt}}[[Category:Documents]][[Category:Unit Sales Documents]]