Document Configuration - Order Processing Document
The Platinum System " Order Processing" allows the layout of your outgoing Order Processing documents 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.
This article is for the following documents :-
- "Purchase Orders"
- "Delivery (or Advice) Notes"
- "Order Confirmations"
- "Picking Lists"
Contents
Layout Data Formats
Formats are stored in a special file, which must be accessed through the format amendments programs. It cannot be edited from outside the Platinum System.
A library of "Standard Formats" is available. These are automatically copied to the "User Format" the first time a document is printed, and may be copied manually if, for instance, you wish to start using pre-printed stationary where before you were using plain paper.
If required, you may assign special formats to certain Accounts, and/or assign these formats to different print records from the default. A format name may be up to 11 characters in length, and contain any combination of typeable characters.
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 document 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 | (30 characters) Account Name
| ||
~2,n | (30 characters) Account Address Line
| ||
~3,n | Account Code/Reference
| ||
~4,n | Telephone Number/Email Address
| ||
~5 | (15 characters) Fax Number
| ||
~6,n,m | Account Notes Line
| ||
~7 | (3 characters) Page Number
| ||
~8,n | User Date
| ||
~9,n | (15 characters) Your Order Number
| ||
~8,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
| ||
~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
| ||
~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 | (3 characters) Total Number of Pages
| ||
~33 | (6 characters) Account Group
| ||
~34,n | Skip line unless Document Type Match
This token is only applicable to "Delivery Notes"
| ||
~44,n | (30 characters) Delivery Addresses
| ||
~45,n | (5 characters) Current Time
| ||
~48 | (8 characters) Delivery Note/Goods Received Note/Picking List Number
| ||
~49,n | (15 characters) Customer/Supplier Order Number
| ||
~50 | Skip block until next ~50
Print Spaces if delivery address is blank. | ||
~51 | (10 characters) Total Quantity - Excludes Backorder Items
| ||
~52,n | (60 characters) Order Extra Notes
| ||
~53 | (10 characters) Delivery Note: Delivery Method, if entered
| ||
~54 | (10 characters) Delivery Note: Consignment Number, if entered
| ||
~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 | (4 characters) Delivery note: Number of boxes
| ||
~61,n | (8 characters) User/Group Name
| ||
~62 | (10 characters) Total Weight
Excludes Backorder Items. | ||
~63 | (10 characters) Total Volume
Excludes Backorder Items. | ||
~65,n | (3 characters) Order Status
| ||
~211 | (10 characters) Account Reference
| ||
~212,n | (10 characters) Barcode Checksum/Total
Total of all the barcode number for each Stock Code on the document.
| ||
~213,n | (1 character) Account Analysis Code
| ||
~214,n,m | Account Analysis Description
| ||
~215,n | (60 characters) Account Extra Notes
| ||
~224 | (30 characters) History Notes
For Goods Received Notes. | ||
~234 | (30 characters) Account V.A.T. Registration Number
| ||
~255,"x" | Skip block until next ~255
Print spaces if the account does not have the given account attribute set.
| ||
~256,n,"x",m | (30 characters) Account Attribute
Print an account attribute code or description.
| ||
~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 Documents, 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
~105,n,m,l | Enables grouping of multiple Stock Codes
Enables grouping of multiple Stock Codes into single lines on the document. The parameter 'n' is the number of characters at the start of the code which must be identical for the codes to be grouped. parameter 'm' is the number of characters following these parameter 'n' characters which must be identical in order for the items to occupy one "column". parameter 'l' is the number of "columns" allowed per line.. | ||
~109,n | Body Print Style, Document Style 1
| ||
~110,n | Body Print Style, Document Style 2
| ||
~111,n | Line Skip
| ||
~112,n | Heading Block
| ||
~113,n,m | Body Block
| ||
~114,n | Footing Block
| ||
~115,n | Form Length
| ||
~117,n,m | Back Order information
Prints a section after the Order Items consisting of Items on backorder for the current account, using the same line layout as for the Order Items.
| ||
~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 document body.
All have up to seven parameters :-
- Parm 1 - 'n'
- Column Position across from the left of the page (Document Style 1).
- Parm 2 - 'm'
- Column Position across from the left of the page (Document Style 2). Delivery notes only.
- 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 5 - 'k'
- Column, when '~105' is used. See above. Up to 10 columns are allowed, limited by the "col" parameter after '~105'. If the body token is to refer to the line total, or main text item, then this parameter should be '0' (the default). If it is to refer to the value for a specific column then it should be given the value 1 - 10.
- 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 may be used in the Headers or Footers, and will in this case take their value from the first order which appears on the Document.
|
==== Body Tokens ====>>BOT-0 https://www.catalyst-uk-support.com/kb/ REF:opdocssales New redirection changes