| Database Definitions / Transfer database fields | |
This topic contains a description of the fields used for the transfer log database feature. The same fields appear in the database columns and the XML file, depending on how you store the data.
| Column/Field Name | Data Type | Length | Description |
|---|---|---|---|
| TransferID | VARCHAR | 30 | Database only
Transfer ID (generated by Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application and used as a "key" to the records) |
| ExternalID | VARCHAR | 50 | Optional external ID provided by end user application |
| MessageID | VARCHAR | 100 | Message ID (generated either by Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application or the remote host) |
| Folder | VARCHAR | 50 | Database only
Host folder alias |
| Host | VARCHAR | 50 | Host Alias |
| Mailbox | VARCHAR | 50 | Mailbox Alias |
| MailboxID | VARCHAR | 255 | Database only
Optional identifier set via mailbox externalID property. |
| Username | VARCHAR | 50 | Database only
Name of user performing the transfer. If it matches the Mailbox, then this is null. |
| Action | VARCHAR | 50 | Action Alias |
| Transport | VARCHAR | 12 | Transport |
| StartDT | VARCHAR | 20 | Start Date and
Time the file transfer started Format: yyyy/mm/dd hh:mm:ss |
| EndDT | VARCHAR | 20 | End Date and Time
the file transfer completed Format: yyyy/mm/dd hh:mm:ss |
| Direction | VARCHAR | 10 | Direction
Possible values include send or receive, or inbound or outbound for CHECK commands |
| IsReceipt | VARCHAR | 1 | Receipt
file Possible values: T=True; F=False |
| Status | VARCHAR | 15 | Status
Possible values:
* Database payload only: A status of Interim Success when using database payload indicates that the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom FTP or SSH FTP server received a file, but it was not stored by the FTP user into the user's configured inbox subdirectory. Another transfer will be logged with a status of Success if and when the file is moved into the inbox directory by the FTP user via FTP rename commands. In fact, when the file is renamed by the FTP user, the payload is actually inserted into the VLIncoming database table at that time. See Database payload for more information on the database payload feature. |
| OrigName | VARCHAR | 100 | Original filename
If the file is a zip archive, this field contains zip filename[entry name] |
| OrigPath | VARCHAR | 200 | Original path |
| OrigFileDT | VARCHAR | 20 | Original file
date/time stamp Format: yyyy/mm/dd hh:mm:ss |
| FileSize | BIGINT | File size | |
| TransferTime | FLOAT | 20 | Transfer time in seconds |
| TransferBytes | BIGINT | Transfer bytes | |
| CRC | VARCHAR | 12 | Database only
CRC-32 value associated with the transfer, or NULL if CRC is not available |
| ResultText | VARCHAR | 500 | Result text |
| FileHeader | VARCHAR | 100 | File Header (future use) |
| VLSerial | VARCHAR | 6 | Database only
Cleo Harmony, Cleo VLTrader, or Cleo LexiCom license serial number (in case multiple product instances sharing database) |
| CopyPath | VARCHAR | 500 | Database
only Contains the path to the sentbox/receivedbox copy or NULL if a copy is not available. |
| RunType | VARCHAR | 30 | Database
only Contains the run type (for example, Interactive, Scheduled, Unsolicited, and so on) or NULL if the run type is not available. |
| PreviousTransferID | VARCHAR | 30 | Database
only If RunType = Resend, contains the transfer ID of the transfer on which this transfer was based. Otherwise, it is NULL. |
| Command | VARCHAR | 500 | Database
only The original command string. Only present for CHECK commands. |
| InteractiveUsername | VARCHAR | 50 | Database
only Name of user running the action interactively. |
| StartNDT | DATETIME | Database
only DateTime version of StartDT |
|
| EndNDT | DATETIME | Database
only DateTime version of EndDT |
|
| TradingPartnerAlias | VARCHAR | 255 | Database
only Alias of trading partner associated to the host/mailbox or to the ID if tracking is enabled. |
| FileType | VARCHAR | 255 | Database
only File extension of transferred file |
| TrackedType | VARCHAR | 25 | Database
only If the file is tracked, this is the tracked type. Possible values are EDI, TEXT, or XML. |
| IPAddress | VARCHAR | 45 | Database
only IP Address of remote computer used for local user IP filtering. |
| StartDTInt | BIGINT | Milliseconds epoch version of StartDT | |
| EndDTInt | BIGINT | Milliseconds epoch version of EndDT |