Wrangler
Application Protocol
WRANGLER
APPLICATION PROTOCOL
CSC – HOST INTERFACE SPECIFICATION
Journal:
074 887 061 CSC - Host Interface Specification - Application Protocol.doc
Date:
Feb 14, 2008
Revision:
1
Pages:
14
Initials:
PFO
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
1/14
Wrangler
Application Protocol
CONTENTS
Page
1
REVISIONS ...............................................................................................................3
2
INTRODUCTION .......................................................................................................4
2.1
REFERENCES ..........................................................................................................4
2.2
TRANSPORT PROTOCOL .......................................................................................4
3
APPLICATION LEVEL PROTOCOL .........................................................................5
4
TELEGRAM LIST ......................................................................................................6
5
TELEGRAM CONTENTS ..........................................................................................7
5.1
10 - QUERY MESSAGE ............................................................................................7
5.2
11 – POSITIVE ACKNOWLEDGEMENT ..................................................................7
5.3
12 – LOGICAL ERROR ACKNOWLEDGEMENT .....................................................7
5.4
20 - TABLE OPEN .....................................................................................................7
5.5
21 - TABLE RECORD INSERT .................................................................................8
5.6
22 - TABLE RECORD DELETE ................................................................................8
5.7
23 - TABLE CLOSE ...................................................................................................9
5.8
24 - TABLE ACTIVATE..............................................................................................9
5.9
25 - TABLE REMOVE................................................................................................9
5.10
40 – DIVERT VERIFICATION ...................................................................................9
6
COMMUNICATION EXAMPLES .............................................................................11
6.1
QUERY AND OK ANSWER (LINE 1)......................................................................11
6.2
ILLEGAL TELEGRAM TYPE (LINE 1) ....................................................................11
6.3
TRANSMISSION OF DATA – DOWNLOAD (LINE 1).............................................11
6.4
TRANSMISSION OF DATA – UPLOAD (LINE 2) ...................................................12
6.5
ACTIVATE TABLE (LINE 1) ....................................................................................12
7
ASCII CODES..........................................................................................................13
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
2/14
Wrangler
Application Protocol
1
REVISIONS
Rev.
Date
Init.
Description
1
Feb14, 2008
PFO
First revision.
Created based on document 074.058.007 from
August 1993.
Reviewed by TAN, MIP
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
3/14
Wrangler
Application Protocol
2
INTRODUCTION
The present document describes the Application Protocol for the transfer of:
• Sorting table information from the Wrangler Host to the CSC.
• Divert information from the CSC to the Wrangler Host.
2.1
2.2
REFERENCES
[1]
Title:
Document:
Date:
Revision:
System description, CSC
074 887 01v System Description CSC.doc
Feb 11, 2008
1/TAN
[2]
Title:
Document:
Date:
Revision:
TCP/IP Transport Protocol, CSC – Host interface
074 887 02v CSC – Host Interface Specification - Transport Protocol.doc
Feb 14, 2008
1/MIP
TRANSPORT PROTOCOL
The transport protocol is defined in [2].
Two separate socket connections lines are used for communication. This configuration
is maintained from the old system.
The configuration of this protocol for download of sorting table information (line 1) is:
• Server: Host
• Client: CSC
The configuration of this protocol for upload of divert information (line 2) is:
• Server: Host
• Client: CSC
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
4/14
Wrangler
Application Protocol
3
APPLICATION LEVEL PROTOCOL
The application level protocol describes the information flow between the two systems.
The telegram content consists of ASCII-characters. All values between and including
0x20 and 0x7e are allowed.
A telegram consists of a request code and a number of numerical/alphanumerical fields.
(Note: some telegrams may only consist of a request-code).
The request code consists of 2 digits (the first two characters in the telegram) and is
used to identify the telegram.
If the alphanumeric information does not take up the entire telegram field, spaces
(0x20) will be suffixed. In the telegram description, the alphanumeric fields are indicated
by lower case letters.
If the numerical information does not take up the entire telegram field, zeros (0x30) will
be prefixed. In the telegram description, the numerical fields are indicated by lower
letters.
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
5/14
Wrangler
Application Protocol
4
TELEGRAM LIST
The telegrams are grouped according to how they are being used in the system.
The 2 first characters for each telegram designate the telegram type. The
telegram is transmitted on 2 different communication lines.
Line 1 is used for downloading of data from Host to CSC, line 2 for uploading
of data from CSC to Host. Some telegrams are used on both lines as indicated in
the tables below. Furthermore the telegram designation characters are changed
to numerical values.
Telegram type
New
designation
digits
Old
designation
characters
Transmission
direction
Line
Query Message
10
QU
CSC → Host
1
Positive
Acknowledgement
11
OK
Host → CSC
1,2
Logical Error
12
EL
Host → CSC
1,2
Table Open
20
TO
Host → CSC
1
Table Record Insert
21
TI
Host → CSC
1
Table Record Delete
22
TD
Host → CSC
1
Table Close
23
TC
Host → CSC
1
Table Active
24
TA
Host → CSC
1
Table Remove
25
TR
Host → CSC
1
Divert Verification
40
DV
CSC → Host
2
Note: The transmission error telegram (ET) from the old interface is no longer
applicable.
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
6/14
Wrangler
Application Protocol
5
TELEGRAM CONTENTS
The contents of all telegrams used on the communication line are shown below.
5.1
10 - QUERY MESSAGE
At a specified time interval the CSC sends a query message to the Host and asks for
new data.
Format: 10ss
ss
*1:
Status of Host’s latest data telegram
00 = OK
01 = Disk space full (Not supported by new CSC)
02 = Delete non-existing record
03 = Insert record already existing
04 = Delete used record *1
05 = Delete non-existing table
06 = Table open fail (e.g. illegal name)
07 = Too many records
08 = Parameter error (e.g. illegal destination chute, illegal table type)
09 = Illegal telegram type
If the Host tries to delete an already used record, this warning is send to the
Host. If the Host still wants to delete the record, the telegram must be send
again with type “F”.
Communication Direction: CSC → Host
When the Host has no data to send on line 1, the CSC will send query telegrams to the
Host at 10-second intervals. The interval between queries is an adjustable parameter in
the CSC.
5.2
11 – POSITIVE ACKNOWLEDGEMENT
Used for acknowledgement of data telegrams and acknowledgement of query
telegrams, if there is no data to transfer.
Format: 11
Communication Direction: Host → CSC
5.3
12 – LOGICAL ERROR ACKNOWLEDGEMENT
The SLAVE uses this answer if it receives a telegram of undefined type.
Format: 12
Communication Direction: Host → CSC
5.4
20 - TABLE OPEN
Used for opening a sorting table before editing. This telegram must be sent before any
insert or delete telegrams are sent.
Format: 20nnnnnnnnto
nnnnnnnn Any 8 ASCII characters within the limits A-Z or 0-9. If fewer than 8
characters are wanted, the appending spaces must be filled in. *1
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
7/14
Wrangler
Application Protocol
t
Type of table:
S = Shipping
R = Replenishment
o
Open type:
C = Create (i.e. if table already exists, it will be erased)
O = Open (i.e. if table already exists, all operations will be regarded
as changes to existing table) *2
*1:
The table name is now 8 characters. In the old interface it was 8 characters plus
a 3 character extension.
*2:
If the table isn’t existing, the CSC will send a query telegram with a “table open
failed” extension.
Communication Direction: Host → CSC
5.5
21 - TABLE RECORD INSERT
Inserting one or more records in an already opened sorting table.
Format: 21rrddddeeeellccc...ccc
rr
01-10 number of records in this telegram. If rr is greater than 1, then
the rest of the telegram (ddddeeeellccc…ccc) is added rr-1 times.
dddd
Destination chute 1. First destination chute for this code. The
destination chute is 4 digits long
eeee
Destination chute 2. Second destination chute for this code. If only
one destination chute is desired, then this field must be filled with
spaces.
ll
Code type and length:
09 = Replenishment
20 = Shipping
ccc…ccc
This field contains the code. The length of the field is found by from ll
Only characters 0-9, can be used.
If a record with a code which already exists in the sorting table is downloaded, the
following will happen:
Shipping code
If the code has only one destination chute assigned the new
destination chute downloaded will be added to the record.
If the code already has two destination chutes assigned or if
two new destination chutes are downloaded the CSC will
respond with status “Insert record already existing” in the next
query telegram (see section 5.1).
Replenishment code The code is deleted from the table and the new record is
inserted with one or two destination chute as downloaded.
Communication Direction: Host → CSC
5.6
22 - TABLE RECORD DELETE
With this telegram it is possible to delete one record in an already opened sorting table.
If type W is specified, the table is active and the record has already been used, then the
CSC will respond with status “Delete used record” in the query telegram.
Format: 22tllccc…ccc
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
8/14
Wrangler
Application Protocol
t
ll
ccc…ccc
Delete type:
W = Warning if table is active and record has already been used.
F = Force delete without warning.
Code type and length:
09 = Replenishment
20 = Shipping
Code to delete. The length of the field is found by from ll. Only
characters 0-9 can be used.
Communication Direction: Host → CSC
5.7
23 - TABLE CLOSE
Used for closing of a sorting table after editing. This telegram must be sent before a
new open telegram is sent; that is, only one table at a time can be edited.
Format: 23
Communication Direction: Host → CSC
5.8
24 - TABLE ACTIVATE
Used for activation of a sorting table in the CSC. At the same time a wave number is
assigned to active sorting table (not used by CSC). The previously active table is
implicitly still active as "previous active" until the next TABLE ACTIVE telegram of the
same table type is sent and it then becomes passive.
Format: 24nnnnnnnntww
nnnnnnnn Any 8 ASCII characters within the limits A-Z or 0-9. If fewer than 8
characters are wanted, the preceding spaces must be filled in.
t
Table type:
R = Replenishment
S = Shipping
ww
00-99 (Not used by CSC)
Communication Direction: Host → CSC
5.9
25 - TABLE REMOVE
This telegram is used to remove a sorting table from disk.
Format: 25nnnnnnnnt
nnnnnnnn Any 8 ASCII characters within the limits A-Z or 0-9. If fewer than 8
characters are wanted, the preceding spaces must be filled in.
t
Table type:
R = Replenishment
S = Shipping
Communication Direction: Host → CSC
5.10
40 – DIVERT VERIFICATION
Used to send divert information to the Host. Contains the final destination chute of an
item with the specified code.
Format: 40ddddllccc…ccc
dddd
Final destination of the item. Must be 4 digits.
ll
Table type and length:
09 = Replenishment
20 = Shipping
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
9/14
Wrangler
Application Protocol
ccc…ccc
The code on the item. The length of the field is found by from ll. Only
characters 0-9 can be used.
Communication Direction: CSC → Host
Records are added to the queue for transmission after diverts of the items have been
verified. The table below summarize when divert of an item results in a record being
added to the queue for upload:
Divert
Upload? Comment
Item sorted to normal chute
Yes
Item with code not found
No
Item(s) dumped for manual
handling.
An already sorted item sorted to
normal chute again
Yes
I.e. the same code may be sent
several times.
Item with two or more Codes.
(Multiple labels)
No
Item(s) dumped for manual
handling.
Item dumped due to being recirculated because of full chutes
No
Item(s) dumped for manual
handling.
Upload is only done for items with barcodes matching either the full 20-digit Shipping
barcode, or the 9-digit Replenishment barcode.
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
10/14
Wrangler
Application Protocol
6
COMMUNICATION EXAMPLES
6.1
QUERY AND OK ANSWER (LINE 1)
6.2
CSC:
1000
Query
Host:
11
Acknowledge
ILLEGAL TELEGRAM TYPE (LINE 1)
CSC:
1000
Query
Host:
45
Illegal telegram type
CSC:
1009
Query
Host:
11
Correct telegram
Wait 10 seconds...
6.3
CSC:
1000
Query
Host:
11
Acknowledge
TRANSMISSION OF DATA – DOWNLOAD (LINE 1)
CSC:
1000
Query
Host:
11
Acknowledge
Wait 10 seconds...
CSC:
1000
Query
Host:
20LOOKUPSpSpRC
Create replenishment table LOOKUP
CSC:
1000
Query
Host:
21010023014309123456789
Insert record 123456789 with
destination chutes 0023 and 0143
CSC:
1000
Query
Host:
21010102SpSpSpSp09123456780
Insert record 123456780 with
destination chute 0102
CSC:
1000
Query
Host:
21020102SpSpSpSp09123456780
0103002009123456781
Insert record 123456780 with
destination chute 0102, and second
record 123456781 with destination chutes
0103 and 0020
CSC:
1000
Query
Host:
23
Table close
CSC:
1000
Query
Host:
11
Acknowledge
Wait 10 seconds...
CSC:
1000
Query
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
11/14
Wrangler
Application Protocol
Host:
6.4
11
Acknowledge
TRANSMISSION OF DATA – UPLOAD (LINE 2)
CSC:
40011709123456789
Item with code 123456789
sorted to destination chute 0117.
Host:
11
Acknowledge
CSC:
40011809123456780
Item with code 123456780
sorted to destination chute 0118.
Host:
11
Acknowledge
Time between diverts is random, dependant on sorter activity.
6.5
ACTIVATE TABLE (LINE 1)
CSC:
1000
Query
Host:
11
Acknowledge
Wait 10 seconds...
CSC:
1000
Query
Host:
24LOOKUPSpSpR00
Activate replenishment table LOOKUP
CSC:
1000
Query
Host:
11
Acknowledge
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
12/14
Wrangler
Application Protocol
7
ASCII CODES
Character or control
ASCII
Character or control
ASCII
NUL
00
SP
20
SOH
01
!
21
STX
02
"
22
ETX
03
#
23
EOT
04
$
24
ENQ
05
%
25
ACK
06
&
26
BEL
07
/
27
BS
08
(
28
HT
09
)
29
LF
0A
*
2A
VT
0B
+
2B
FF
0C
,
2C
CR
0D
-
2D
SO
0E
.
2E
SI
0F
/
2F
DLE
10
0
30
DC1 (X-ON)
11
1
31
DC2 (TAPE)
12
2
32
DC3 (X-OFF)
13
3
33
DC4 (TAPE)
14
4
34
NAK
15
5
35
SYN
16
6
36
ETB
17
7
37
CAN
18
8
38
EM
19
9
39
SUB
1A
:
3A
ESC
1B
;
3B
FC
1C
<
3C
GS
1D
=
3D
RS
1E
>
3E
US
1F
?
3F
@
40
\
60
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
13/14
Wrangler
Application Protocol
Character or control
ASCII
Character or control
ASCII
A
41
a
61
B
42
b
62
C
43
c
63
D
44
d
64
E
45
e
65
F
46
f
66
G
47
g
67
H
48
h
68
I
49
i
69
J
4A
j
6A
K
4B
k
6B
L
4C
l
6C
M
4D
m
6D
N
4E
n
6E
O
4F
o
6F
P
50
p
70
Q
51
q
71
R
52
r
72
S
53
s
73
T
54
t
74
U
55
u
75
V
56
v
76
W
57
w
77
X
58
x
78
Y
59
y
79
Z
5A
z
7A
[
5B
[
7B
\
5C
|
7C
]
5D
] (ALT MODE)
7D
^
5E
~
7E
_
5F
DEL (DELETE)
7F
© FKI Logistex 2008
Feb 14, 2008
CSC - Host Interface Specification
PFO
("074 887 061 CSC - HOST INTERFACE SPECIFICATION - APPLICATION PROTOCOL.DOC")
14/14