Difference between revisions of "Ticket Configuration - Logistics Management Document"

Revision as of 15:58, 7 July 2008

The Platinum System allows the layout of "Logistics Management" Tickets 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.

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	x = Default currency modifier (optional)

Token File Names

The layout files are stored in the 'sxco1\docs' folder, (or 'sxco2', 'sxco3', etc).

'SXTI006.EPL': Ticket layout.

Tokens

General Tokens

~1

(30 characters)

Customer Company Name

~2

(30 characters)

Customer Address Line 1

~3

(30 characters)

Customer Address Line 2

~4

(30 characters)

Customer Address Line 3

~5

(30 characters)

Customer Address Line 4

~6

(30 characters)

Customer Address Line 5

~7

(25 characters)

Ticket Extra Notes Line 1

~8

(60 characters)

Ticket Extra Notes Line 2

~9

(60 characters)

Ticket Extra Notes Line 3

~10

(60 characters)

Ticket Extra Notes Line 4

~11

(60 characters)

Ticket Extra Notes Line 5

~12

(10 characters)

Short Date

~13

(30 characters)

Long Date

~14

(15 characters)

Ticket Line 1

~15

(15 characters)

Ticket Line 2

~16

(15 characters)

Ticket Line 3

~17

(23 characters)

Text Box 1 Line 1

~18

(23 characters)

Text Box 1 Line 2

~19

(23 characters)

Text Box 1 Line 3

~20

(23 characters)

Text Box 1 Line 4

~21

(23 characters)

Text Box 1 Line 5

~22

(23 characters)

Text Box 2 Line 1

~23

(23 characters)

Text Box 2 Line 2

~24

(23 characters)

Text Box 2 Line 3

~25

(23 characters)

Text Box 2 Line 4

~26

(23 characters)

Text Box 2 Line 5

~27

(23 characters)

Text Box 3 Line 1

~28

(23 characters)

Text Box 3 Line 2

~29

(23 characters)

Text Box 3 Line 3

~30

(23 characters)

Text Box 3 Line 4

~31

(23 characters)

Text Box 3 Line 5

~32

(10 characters)

Rate

~33

(10 characters)

Quantity

~34

(10 characters)

Nett

~35,n

(10 characters)

Prompt for Text Block 1

n = 1 -> 5: Line index.

~36,n

(10 characters)

Prompt for Text Block 2

n = 1 -> 5: Line index.

~37,n

(10 characters)

Prompt for Text Block 3

n = 1 -> 5: Line index.

~38

(10 characters)

Prompt for Quantity

~39

(10 characters)

Prompt for Rate

~40,n

(8 characters)

Driver Code

n = 1 -> 6: Driver index.

~41,n

(30 characters)

Driver Name

n = 1 -> 6: Driver index.

~42,n

(8 characters)

Vehicle Code

n = 1 -> 6: Vehicle index.

~43,n

(30 characters)

Vehicle Name

n = 1 -> 6: Vehicle index.

~44,n

(10 characters)

Prompt for Ticket Block

n = 1 -> 3: Line index.

~46

(3 characters)

Ticket Analysis Codes as a block of 3 Letters

~47

(1 character)

Ticket Analysis Code 1

~48

(1 character)

Ticket Analysis Code 2

~49

(1 character)

Ticket Analysis Code 3

~50

(15 characters)

Ticket Analysis Description 1

~51

(15 characters)

Ticket Analysis Description 2

~52

(15 characters)

Ticket Analysis Description 3

~53

(10 characters)

Customer Account Reference

~54

(6 characters)

Customer Account Group

~55

(6 characters)

Customer Account Code

~56,n

(60 characters)

Ticket Extra Notes Line

n = 1 -> 999: Extra Note line index.

~57,n

(40 characters)

Company Name

n = 1 -> 2: Line number

~58

(10 characters)

Ticket Quantity Prompt

~59,n

(10 characters)

Text Block Date

n = 1 -> 3: Block index.

~60,n

(5 characters)

Text Block Time

n = 1 -> 3: Block index.

~61

(8 characters)

Load Reference

~62,n

(30 characters)

Load Notes

n = 1 -> 2: Notes index.

~63

(2 characters)

Pallets

~64

(12 characters)

Weight

~65

(12 characters)

Volume

~66

(3 characters)

Area Code

~67

(30 characters)

Area Code Description

~68

(8 characters)

Trailer

~69

(30 characters)

Trailer Description

~70,n

(25 characters)

Text Block Contact

n = 1 -> 3: Block index.

~71,n

(25 characters)

Text Block Phone

n = 1 -> 3: Block index.

~72,n

(25 characters)

Text Block Open Time

n = 1 -> 3: Block index.

~73,n

(25 characters)

Text Block Close Time

n = 1 -> 3: Block index.

~74,n

Customer Telephone Number

n = 0: (15 characters)
Telephone Number.
n = 1: (20 characters)
Mobile Number.

~75,n,m,l

Form Length

This code must be on it's own line, as everything elese on a line that has this token will be ignored.

n: Current line number.
m: Form Length.
l: Form Break.

~76

Form Feed

This code must be on it's own line, as everything elese on a line that has this token will be ignored.

~90

(2 characters)

Half Pallets

~91

(2 characters)

Quarter Pallets

~92

(2 characters)

Blue Pallets

~93

(2 characters)

Over Size Pallets

~94

(3 characters)

Consignment Type

~95

(30 characters)

Consignment Type Description

~96

(3 characters)

Service

~97

(30 characters)

Service Description

~98

(3 characters)

Input Period

~99

(30 characters)

Input Period Description

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".
~89	Space Compression Turn space compression on and off (default). Multiple spaces on a line will be compressed down into one space.

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 document 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	x = Default currency modifier (optional)

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

@@ Line 1: / Line 1: @@
 The Platinum System allows the layout of "Logistics Management" Tickets 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.
+== 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)'''
+|}
 == Token File Names ==
 The layout files are stored in the {{FilePath|sxco1\docs}} folder, (or {{FilePath|sxco2}}, {{FilePath|sxco3}}, etc).

Difference between revisions of "Ticket Configuration - Logistics Management Document"

Revision as of 15:58, 7 July 2008

Contents

Currency Configuration

Token File Names

Tokens

General Tokens

Print Style Tokens

Currency Conversions

Currency Configuration

Currency Tokens

Navigation menu

Personal tools

Search

Customer Care