Document Configuration - Unit Workshop Document
From Catalyst
The Platinum System " Unit Workshop" allows the layout of your Invoices, Credits, Quotations and Payment 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 document..
Layout Data File Names
The layout files are stored in the 'SXCo1\Docs' folder, (or 'SXCo2', 'SXCo3', etc).
Invoice
- 'WS_PLAWN.INV'
- Plain Paper (Windows Version)
- 'WS_PLA.INV'
- Plain Paper
- 'WS_LET.INV'
- Letter Head
Credit Note
- 'WS_PLAWN.CRE'
- Plain Paper (Windows Version)
- 'WS_PLA.CRE'
- Plain Paper
- 'WS_LET.CRE'
- Letter Head
Quotations
- 'WS_PLA.QUO'
- Plain Paper
- 'WS_LET.CNF'
- Letter Head
Receipts
- 'WS_PLA.REC'
- Plain Paper
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:
- 'SXWS017.EPL'
- Invoice
- 'SXWS018.EPL'
- Credit Note
- 'SXWS019.EPL'
- Quotation
- 'SXWS020.EPL'
- Payment Receipt
- 'SXWS023.EPL'
- Invoice (Warranty)
- 'SXWS024.EPL'
- Credit Note (Warranty)
Layout Tokens
Tokens are indicated by the character '~' 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 invoice/credit/quotation/receipts layouts are divided into 3 main areas: "Headings", "Body" & "Footings".
Area Tokens
| ~100 | Configuration Section Start | |
| ~199 | Configuration Section End | |
| ~200 | Heading Block (First Page) Start | |
| ~299 | Heading Block (First Page) End | |
| ~300 | Heading Block (Continuation) Start | |
| ~399 | Heading Block (Continuation) End | |
| ~400 | Footing Block (Continuation) Start | |
| ~499 | Footing Block (Continuation) End | |
| ~500 | Footing Block (Last Page) Start | |
| ~599 | Footing Block (Last Page) End | |
| ~600 | Body Block Start | |
| ~699 | Body Block End | |
| ~700 | Totals Configuration Block Start | |
| ~799 | Totals Configuration Block End | |
| ~800 | Tax Configuration Block Start | |
| ~899 | Tax Configuration Block End |
Tokens
General Tokens
These can appear in either Headers or Footers.
| ~1,n | (30 characters) Account Name
| |||||||||
| ~2,n,m | (30 characters) Account Address
| |||||||||
| ~3,n | (30 characters) Account Code
| |||||||||
| ~4,n,m | Telephone Number / Email Address
| |||||||||
| ~5,n | (15 characters) Fax Number
| |||||||||
| ~6,n,m,l | Account Notes Line
| |||||||||
| ~7 | (3 characters) Page Number
| |||||||||
| ~9,n | (8 characters) Document Number
| |||||||||
| ~10,n | Document Date
| |||||||||
| ~11,n | (40 characters) Company Name
| |||||||||
| ~12,n | (50 characters) Company Address
| |||||||||
| ~13,n | (one line) Heading Line
| |||||||||
| ~14,n | (one line) Footing Line
| |||||||||
| ~15 | (11 characters) Heading Document Type
| |||||||||
| ~16 | Skip block until next ~16
Print Spaces if "Document" is intended for both the Owner and Insurer. i.e. They both have something to contribute to the total. | |||||||||
| ~17 | Top Left hand corner of Totals Block
Use if totals are to be printed in self configuring block. See below. | |||||||||
| ~18 | Top Left hand corner of Tax Details Block
Use if tax is to be printed in self configuring block. See below. | |||||||||
| ~19 | (10 characters) Total: Amount Before Tax or Blanket Discount
| |||||||||
| ~22 | (10 characters) Total: Tax Amount
| |||||||||
| ~23 | (10 characters) Total: Amount after Tax and Blanket Discounts
| |||||||||
| ~25 | (10 characters) Total: Amount Paid
| |||||||||
| ~117 | (10 characters) Total: Amount Paid (including change)
| |||||||||
| ~118 | (10 characters) Change Given
| |||||||||
| ~120,n,"x",m | Payments Tendered Layout
| |||||||||
| ~26 | (10 characters) Total: Amount Outstanding after Payment
| |||||||||
| ~27,n | (5 characters) Percentage Charged at Tax Rate
| |||||||||
| ~28,n | (10 characters) Description for Tax Rate
| |||||||||
| ~29,n | (10 characters) Amount Taxed at Tax Rate
| |||||||||
| ~30,n | (10 characters) Amount of Tax Charged at Tax Rate
| |||||||||
| ~31,n | (10 characters) Amount after Tax at Tax Rate
| |||||||||
| ~32,n | (25 characters) Unit Image Path
| |||||||||
| ~33,n | (30 characters) Account Name
| |||||||||
| ~34 | (10 characters) System Parameters word for distance.
e.g. "Mileage" or "Kilometers" | |||||||||
| ~35 | (10 characters) Unit Key Number
| |||||||||
| ~36 | (8 characters) Unit Engine Size
| |||||||||
| ~37 | (3 characters) Unit Manufacturer Code
| |||||||||
| ~38 | (10 characters) Unit Registration Date
| |||||||||
| ~39,n,m | Sale Unit Model
| |||||||||
| ~40 | (10 characters) Unit MOT Expiry Date
| |||||||||
| ~41 | (30 characters) Unit Manufacturer Name
| |||||||||
| ~42,n | Sale Unit Location
| |||||||||
| ~43 | (10 characters) Unit Purchase Date
| |||||||||
| ~44,n | (10 characters) Unit Sales Date
| |||||||||
| ~45,n | (5 characters) Current Time
| |||||||||
| ~46 | (20 characters) Job Reference
| |||||||||
| ~47,n | Unit Description
| |||||||||
| ~48 | (10 characters) Unit Registration Number
| |||||||||
| ~49 | (30 characters) Unit V.I.N. Number
| |||||||||
| ~50 | (30 characters) Unit Engine Number
| |||||||||
| ~51 | (8 characters) Job Number
| |||||||||
| ~52,n | (8 characters) Unit Distance
| |||||||||
| ~53 | Skip line unless Insurance Document | |||||||||
| ~54 | Skip line unless Owner Document | |||||||||
| ~55 | (6 characters) Prints the (Country Determined) word for Tax
| |||||||||
| ~56 | (3 characters) Do not print this line if blank
| |||||||||
| ~57 | Skip block until next ~57
Print Spaces if all Items have a date equal to the User Date (e.g. headings.). | |||||||||
| ~58 | Skip block until next ~58
Print Spaces if no Items have an individual discount applied (e.g. headings.). | |||||||||
| ~59 | Skip block until next ~59
Print Spaces if there is no insurance information on this document (owner only document). | |||||||||
| ~60 | Skip block until next ~60
Print Spaces if there is no owner information on this document (insurance only document). | |||||||||
| ~61 | (8 characters) User/Group Name
| |||||||||
| ~62 | (15 characters) Unit Colour
| |||||||||
| ~63 | (30 characters) Unit Chassis Number
| |||||||||
| ~64 | (4 characters) Unit Build Year
| |||||||||
| ~65,n | (8 characters) Job Due Date
| |||||||||
| ~65,n | (8 characters) Job Received Date
| |||||||||
| ~65,n | (8 characters) Job Start Date
| |||||||||
| ~68,n,m | (50 characters) Job Brief Description
| |||||||||
| ~69,n,m | (65 characters) Job Detailed / General Notes
| |||||||||
| ~70,n | (25 characters) Output Control
| |||||||||
| ~71 | (25 characters) Job Status
| |||||||||
| ~72 | (25 characters) Job Status Description
| |||||||||
| ~73 | (25 characters) Insurance or Warranty Claim Number
| |||||||||
| ~74 | (25 characters) Insurance Policy Type
| |||||||||
| ~75 | (25 characters) Insurance Excess
| |||||||||
| ~76 | (25 characters) Insurance Broker
| |||||||||
| ~77,n | (25 characters) Insurance Notes Line
| |||||||||
| ~78 | (25 characters) Insurance Policy/Warranty Contract Number
| |||||||||
| ~201,n | (10 characters) Owner Nett
| |||||||||
| ~202,n | (10 characters) Owner V.A.T.
| |||||||||
| ~202,n | (10 characters) Owner Gross
| |||||||||
| ~204 | (10 characters) Owner Payments
| |||||||||
| ~205 | (10 characters) Owner Outstanding
Gross - Payments = Outstanding. | |||||||||
| ~206,n | (10 characters) Insurer Nett
| |||||||||
| ~207,n | (10 characters) Insurer V.A.T.
| |||||||||
| ~208,n | (10 characters) Insurer Gross
| |||||||||
| ~209 | (10 characters) Insurer Payments
| |||||||||
| ~210 | (10 characters) Insurer Outstanding
Gross - Payments = Outstanding. | |||||||||
| ~211,n | (10 characters) Account Reference
| |||||||||
| ~212 | (8 characters) Unit Stock Number
| |||||||||
| ~213,n,m | (1 character) Account Analysis Code
| |||||||||
| ~214,n,m,l | Account Analysis Description
| |||||||||
| ~215,n,m | (60 characters) Account Extra Notes
| |||||||||
| ~216 | Skip block until next ~216
Print Spaces if a Credit Card Transaction is not involved. | |||||||||
| ~217 | (30 characters) Credit Card Holder Name
| |||||||||
| ~218 | (20 characters) Credit Card Number
| |||||||||
| ~219 | (5 characters) Credit Card Expiry Date, as MM/YY
| |||||||||
| ~220 | (10 characters) Credit Card Authorisation Code
| |||||||||
| ~221 | (2 characters) Credit Card Issue Number
| |||||||||
| ~222 | (5 characters) Credit Card Valid From Date, as MM/YY
| |||||||||
| ~223 | (15 characters) System Merchant Number
| |||||||||
| ~224 | (15 characters) Transaction Comment
| |||||||||
| ~234,n | (30 characters) Account V.A.T. Registration Number
| |||||||||
| ~235,n | (6 characters) Job Depot Code
| |||||||||
| ~236 | Skip block until next ~236
Print Spaces if there is no "betterment" information on this document. | |||||||||
| ~237 | (15 characters) Buying Group Reference
| |||||||||
| ~401 | (80 characters) Top Left hand corner of Credit Charge Text Block
The Credit Charge Text Block is defined in " Reports & Settings Maintenance Options System Administrator Credit Charge Settings" and configures itself according to the details of the current document. | |||||||||
| ~402 | (10 characters) Total: Amount of any Credit Charge Applicable to the Current Document.
| |||||||||
| ~403 | (10 characters) Total: Gross total for the current document, plus any applicable Credit Charge.
|
Configuration Tokens
These affect the overall layout of the invoice/credit/quotation/receipts , 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.
| ~101,n,m | 1st Page Heading Block
| |
| ~102,n,m | Continuation Page Heading Block
| |
| ~103,n,m | Continued Page Footing Block
| |
| ~104,n,m | Final Page Footing Block
|
Document Configuration
| ~109,n | Normal and Slip Body Style
| ||
| ~111,n | Line Skip
| ||
| ~112,n | Heading Block
| ||
| ~113,n,m | Body Block
| ||
| ~114,n | Footing Block
| ||
| ~115,n | Form Length
| ||
| ~119 | Stops "V.A.T. Inclusive" Invoices printing Tax & Grand Total.
This is for items in the '~700' -> '~799' Totals Block, as these can look confusing. | ||
| ~124 | Print a Customer Statement
Automatically prints a customer statement to follow the invoice. No statement will be printed if the customer's account balance is zero following this invoice and any payments made along with it.
| ||
| ~198 | Currency conversion configuration
|
Body Block
General Information
'~6nn,1,2,3,"4",5,6,"7"' where '~6nn' represents an item, described below, which you wish to be printed in the invoice/credit/quotation/receipts body.
All have up to seven parameters :-
- Parm 1 - 'n'
- Column Position across from the left of the page.
- Parm 2 - 'm'
- Unused. (Used by other Systems, but should be set to '0' here if a third parameter is used).
- Parm 3 - 'l'
- Varies by Token. If not used, and parm 4 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,,"4",5.
- Generally, for numeric tokens, which print by default to two decimal places.
- '0' - Quantity : Trailing Zeroes are Stripped off. Currency : Zero figures are not printed.
- '1' - Quantity : Trailing Zeroes are NOT Stripped. Currency : Zero figures are printed.
- '2' - As '0', but allow 3 decimal places.
- '3' - As '1', but allow 3 decimal places.
- Parm 4 - 'x'
- Optional. Varies by token. If used should be contained in quotes. If not used and parm 5 or above required, should be skipped in the same way as parm 3. i.e. ~6nn,1,2,3,,5
- Parm 6 - 'j'
- Varies by Token. If not used, and parms 7 or above are needed, should be skipped by placing the commas next to each other. i.e. ~6nn,1,2,3,"4",5,,"7".
- Parm 7 - 'w'
- Optional. Varies by token. If used should be contained in quotes.
==== Body Tokens ====>>BOT-0 https://www.catalyst-uk-support.com/kb/ REF:wsdocsjobcard New redirection changes
