TTicket Check FTP Upload Process
Overview: The Ticket
Check® positive response system has an option for transferring large status files to be processed
automatically. Members will have the capability of opening an FTP connection and transferring
files containing ticket statuses. These files will automatically be processed in 3 minute
intervals with the results being available afterwards. This document covers the format for the
batch files, the results files, and a general list of directions for using FTP.
FTP Batch Files: All files are
required to follow the provided format with the extension .mn. As part of the
file format, the ticket number, the status code, and the affected district code are required. As
these files are required to be ASCII based, please remember to not transfer the files as binary to
insure that the proper new-lines are provided. If the files do not follow these guidelines, then
the system will not process the files or statuses correctly.
Each entry is to be on its own line. Here is the format
that the file is to follow:
| Field |
Size |
Description |
| Ticket Number |
8 |
The ticket number to be
statused. If the ticket number is less than 8 characters in length then it should be
left-padded with zeroes. |
| Status |
1 |
The number of the status the ticket is to be set. The
available statuses are 1 (Cleared/No Conflict), 2
(Marked), 3 (Marking will be Delayed), and 4
(Not Complete/In Progress). No others will be accepted. |
| District Code |
1-8 |
The associated district code
that is to be statused. The login ID for the user MUST have permission to update the
district code. |
Example file:
506878351OCC01
016878351OCC01
506887992OCC01
506980991MISSUT01
506887991MISSUT02
Files are processed approximately every 3
minutes. If the same file is used multiple times, each additional file will have a .1, .2, etc
at the end of the filename before the .mn extension. You should either use unique names or a
rotation of file names should be used with the extension always being .mn.
Results Files: For
each input file, an output file will be generated that contains the results from the corresponding
submitted ticket, status, and district code. These files will be named the same, but with the
extension .out. With this setup, this means that if 2 files are submitted to
be processed, then 2 result files will be created.
The results files are formatted in the following manner:
TicketNumber1<TAB>DistrictCode1<TAB>Status1<TAB>Date1<TAB>Time1<TAB>
ErrorCode1<TAB>Msg1
TicketNumber2<TAB>DistrictCode2<TAB>Status2<TAB>Date2<TAB>Time2<TAB>
ErrorCode2<TAB>Msg2
TicketNumber3<TAB>DistrictCode3<TAB>Status3<TAB>Date3<TAB>Time3<TAB>
ErrorCode3<TAB>Msg3
TicketNumber4<TAB>DistrictCode4<TAB>Status4<TAB>Date4<TAB>Time4<TAB>
ErrorCode4<TAB>Msg4
…
<EOF>
| Field |
Description |
| Ticket Number |
GSOC ticket number that was updated. |
| District Code |
District code corresponding with the ticket number. |
| Status |
The proposed status for the ticket number. |
| Date/span> |
The date the ticket was processed. |
| Time |
The time the ticket was processed. |
| Result Code |
Displays results of the ticket, district code, and status
update. |
| Description/Message |
English description of the provided success code. |
Please note that each field is separated by the
<TAB> which is represented by the ASCII character 0x09. This allows the results file to
be viewable or programmatically parsed easily.
| Results Code |
Description |
| 00 |
Success |
| 01 |
Ticket does not exist. |
| 02 |
District Codes does not exist. |
| 03 |
Response is unknown value. |
| 04 |
District Code is not valid for Ticket Number. |
| 14 |
Unknown system error. |
| 15 |
Illegal attempt to status ticket cancelled by excavator. |
| 16 |
Login ID does not have permission to status District Code. |
| 18 |
Ticket is already locked. |
| 19 |
Operation Timed Out. Recommend Retry. |
FTP Instructions: The process of
using FTP to transfer files is very simple. This is done by connecting to the site, logging into the system,
and sending the transfer commands. Here is a detailed list of instructions for successfully transferring the
files.
Command/Instructions Description
ftp www.managetickets.com Connects the system to Ticket Check® system.
This should be run from the command line on either Unix,
Linux, or Windows systems.
Enter login at the prompt. User’s login for the system.
Enter the password at the prompt. User’s password for the system.
lcd \Example\TicketFiles Method for moving to the location of the batch files
Substitute the path where the files are located on the
user’s system.
asc This insures that carriage returns and new lines are
transferred correctly from different systems by
setting the transfer to ASCII instead of binary.
put ticketFile.mn Transfers the batch file to be processed. Substitute
the actual name of the file here. Remember to make
sure that the extension is .mn to be processed.
ls *.out Gets the list of available result files.
get example.out Retrieves the result file. Substitute the actual name.
quit Disconnects the system.
Important Login Note:
Logins do not automatically have permission to use the FTP process. A request has to be made
to give permission for logins to be able to use this option. Once created, the login and password for
FTP submission will be provided. If the web site password is changed under the administration screen,
this will not currently affect the FTP password.