Traffic Sheet/Self Billing Configuration - Logistics Management Document

From Catalyst
Revision as of 14:15, 3 July 2008 by ThrashBot (talk | contribs) (Updated from revision control)
Jump to: navigation, search

Document Areas

For the purposes of configuration, the traffic sheet/self billing layouts are divided into 3 main areas: "Headings", "Body" & "Footings".

Tokens

General Tokens

These can appear in either Headers or Footers.

~10
(80 characters)
Auto Heading Line
~11
(3 characters)
Page Number
~12 Print Range (Planning Report Only)
~14
(10 characters)
User Date Short
~20
(40 characters)
Company Name 1
~21
(40 characters)
Company Name 2
~22 Standard Skip Line
~30
(6 characters)
Account Code
~31
(30 characters)
Account Name

Configuration Tokens

These affect the overall layout of the traffic sheet/self billing , 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
n
Start Line (i.e. Line for '~200').
m
End Line (i.e. Line for '~299').
~102,n,m Continuation Page Heading Block
n
Start Line (i.e. Line for '~300').
m
End Line (i.e. Line for '~399').
~103,n,m Continued Page Footing Block
n
Start Line (i.e. Line for '~400').
m
End Line (i.e. Line for '~499').
~104,n,m Final Page Footing Block
n
Start Line (i.e. Line for '~500').
m
End Line (i.e. Line for '~599').

Document Configuration

~109,n,m,l
(Line)
Skip Line Character
n
Start position.
m
End position.
l
Character to print.
~110,n Skip Lines Between Items
n
Number of skipped lines.
~111,n,m Literal Use
n = 1
Literals In Auto Heading.
m = 1
Literals In Skipped Lines.
~112,n Heading Block
n => 1
The line to start printing.
~113,n,m Body Block
n
The line to start printing.
m
Depth (Number of lines to print).
~114,n Footing Block
n
The line to start printing.
~115,n Form Length
n
Number of Lines per Page.
~198 Currency conversion configuration
  • See Currency Conversions at the end of this article for more details.

Body Block

General Information

Up to 50 tokens are allowed across the width of the report, space permitting. In all cases the first parameter gives the column to print the item in. The second and third parameters affect only certain items however.

'~6nn,1,2,3' where '~6nn' represents an item, described below, which you wish to be printed in the traffic sheet/self billing body.

All have up to four parameters :-

Parm 1 - 'n'
Column Position across from the left of the page.
Parm 2 - 'm'
Numeric Columns
1 = Totalled, only available on some columns.
Text Columns
Start line of text to print. If not supplied will print all filled lines.
Text Block Contact
In the case of text block contact information this parameter indicates the text block to use (1 to 3).
Parm 3 - 'l'
Numeric Columns
1 = In the case of a zero total will print '0.00' instead of spaces.
Text Columns
End line of text to print. If parameter 'm' is supplied but not parameter 'l', will print just the line specified by parameter 'n'.

Body Tokens

~601,n
(6 characters)
Account Code
~602,n Ticket Date
~603,n,m,l,k
(15 characters)
Ticket Number
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 3
The starting line to print from.
~604,n,m,l,k
(23 characters)
Text Block 1
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 5
The starting line to print from.
~605,n,m,l,k
(23 characters)
Text Block 2
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 5
The starting line to print from.
~606,n,m,l,k
(23 characters)
Text Block 3
l = 0
Print all used lines
l = 1 -> 3
Maximum Number of lines to print.
k = 1 -> 5
The starting line to print from.
~607,n
(13 characters)
Quantity
~608,n
(13 characters)
Rate
~609,n
(13 characters)
Total
~610,n
(1 character)
V.A.T. Rate
~611,n
(10 characters)
V.A.T. Description
~612,n
(3 characters)
Cost Centre
~613,n
(30 characters)
Centre Description
~614,n,m,l
(1 character)
Ticket Analysis Code
l = 1 -> 3
Analysis Code index.
~615,n,m,l
(15 characters)
Ticket Analysis Description
l = 1 -> 3
Analysis Description index.
~616,n
(8 characters)
Driver
~617,n
(30 characters)
Driver Name
~618,n
(8 characters)
Vehicle
~619,n
(30 characters)
Vehicle Description
~620,n
(3 characters)
Status
~621,n
(30 characters)
Status Description
~622,n
(20 characters)
Contract
~623,n
(3 characters)
Rate Table
~624,n
(30 characters)
Rate Table Description
~625,n
(3 characters)
Table Line
~626,n
(3 characters)
Table Column
~627,n
(30 characters)
Account Name
~628,n
(13 characters)
Driver Allocated Amount
~629,n
(13 characters)
Vehicle Allocated Amount
~630,n
(13 characters)
Centre Allocated Amount
~631,n
(6 characters)
Subcontractor Account Code
~632,n
(30 characters)
Subcontractor Account Name
~633,n
(13 characters)
Subcontracted Rate
~634,n
(13 characters)
Subcontractor Quantity
~635,n
(13 characters)
Subcontractor Total
~636,n
(13 characters)
Profit

e.g. Subcontractor Total - Job Total = Profit.

~637,n
(1 character)
Subcontractor Confirmation Note printed?
~638,n
(8 characters)
Subcontractor Invoice Number

Will be set automatically if allocated by Purchase Ledger link; or may be set manually through Planning View.

~639,n
(8 characters)
Trailer
~640,n
(30 characters)
Trailer Description
~641,n
(2 characters)
Pallets
~642,n
(13 characters)
Weight
~643,n
(13 characters)
Volume
~644,n
(8 characters)
Load
~645,n
(2 characters)
Drop Sequence
~646,n
(3 characters)
Area
~647,n
(30 characters)
Area Description
~648,n
(2 characters)
Half Pallets
~649,n
(2 characters)
Quarter Pallets
~650,n
(3 characters)
Literal
~651,n
(2 characters)
Blue Pallets
~652,n
(2 characters)
Over Size Pallets
~653,n
(8 characters)
Distance
~654,n
(2 characters)
Days
~655,n
(3 characters)
Consignment Type
~656,n
(30 characters)
Consignment Type Description
~657,n
(3 characters)
Service
~658,n
(30 characters)
Service Description
~659,n
(3 characters)
Input Period
~660,n
(30 characters)
Input period Description
~661,n,m,l,k
(23 characters)
Ticket Block Date
l = 1 -> 3
Block number.
k = 0
(10 characters)
Short format. e.g. 'DD/MM/CCYY'.
k = 1
(32 characters)
Long Format. e.g. 'Friday, 31st January 20??'.
~662,n,m,l
(5 characters)
Text Block Time
l = 1 -> 3
Block number.
~663,n,m,l
(30 characters)
Text Block Contact
l = 1 -> 3
Block number.
~664,n
(20 characters)
Text Block Phone
~665,n
(5 characters)
Text Block Open
~666,n
(5 characters)
Text Block Close

Range Block

Totals Tokens

~701
(8 characters)
Driver From
~702
(30 characters)
Driver From Description
~703
(8 characters)
Driver To
~704
(30 characters)
Driver To Description
~705
(8 characters)
Vehicle From
~706
(30 characters)
Vehicle From Description
~707
(8 characters)
Vehicle To
~708
(30 characters)
Vehicle To Description
~709 Date From
~710 Date To
~711
(3 characters)
Status
~712
(30 characters)
Status Description
~714
(6 characters)
Account From
~715
(30 characters)
Account From Name
~716
(6 characters)
Account To
~717
(30 characters)
Account To Name
~718
(1 character)
Scanned Image
~719
(1 character)
History
~720
(8 characters)
Trailer From
~721
(30 characters)
Trailer From Description
~722
(8 characters)
Trailer To
~723
(30 characters)
Trailer To Description
~724
(15 characters)
Ticket 1
~725
(15 characters)
Ticket 2
~726
(15 characters)
Ticket 3
~727
(8 characters)
Load
~728
(8 characters)
Load Attribute
~729
(30 characters)
Text Filter

Print Style Tokens

The following print style codes must have 3 spaces after them as these codes always 6 characters wide.

~79
(6 characters)
Expand
~80
(6 characters)
Unexpand
~81
(6 characters)
Compact
~82
(6 characters)
Uncompact
~83
(6 characters)
Double Strike On
~84
(6 characters)
Double Strike Off
~86
(6 characters)
Paper Forward
~87
(6 characters)
Paper Backward
~88,n
(up to 32 characters)
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".

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 Range Block Start
~799 Range Block End

Currency Conversions

Platinum "Elite" systems only. "Solo" systems will need to be upgraded to "Elite", contact the Catalyst sales team (0116) 230 1500 or your Platinum dealer 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.

The special symbols are currently '$' and '#' (hash symbol, but may have been misprinted as a pound sign). Both of these will cause a conversion to take place; the difference being '#' will suppress the printing of a currency symbol. This can be useful when printers don't have relevant symbols for some currencies.

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 traffic sheet/self billing being printed will be used, if there is one.

Some examples using '~29,1' amount taxed at tax rate 1.
~29,1
no conversion
'*100.00' - (where * is your usual currency symbol).
~29$,1
convert to the account currency (if there is one)
'1005.18F' - (e.g. French Francs.)
~29$12,1
convert to account currency and print to a width of 12
'1005.18F'
~29$USD,1
convert to currency USD (US Dollar)
'$234.56'
~29#12USD,1
same, but suppress the symbol and print to a width of 12
'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.

~198x,n x = Default currency modifier (optional)
n = 0
Use exchange rate as at the user date for all currency conversions.
n = 1
Use exchange rate as at the transaction date for all currency conversions.

Currency Tokens

There is a group of tokens that may be used in headers and footers to print details about the currency set up for the account associated with the document.

~293
(12 characters)
Exchange rate from base currency to account currency
~294
(15 characters)
Sub-units of the currency set for this account
~295
(15 characters)
Units of the currency set for this account
~296
(30 characters)
Name of the currency set for this account
~297
(3 characters)
Code of the currency set for this account
~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

Retrieved from "https://www.catalyst-uk-support.com/kb/index.php?title=Traffic_Sheet/Self_Billing_Configuration_-_Logistics_Management_Document&oldid=4436"