Report File Format
FileCatalyst report files are currently written using a CSV (Comma-separated values) file format. The first line of the file will always contain the headers for each field. The format for both the Data report and the Bandwidth report are as follows.
Data Report Information
| Fields | Values |
| Report Create Time | A positive 64-bit integer value representing milliseconds since 1970 |
| HotFolder | The name for the HotFolder that initiated the transfer |
| Transfer Type | ‘UDP’, ‘FTP’ representing the protocol used for the transfer |
| Direction | ‘UPLOAD’, ‘UPLOAD_RESUME’, ‘DOWNLOAD’, ‘DOWNLOAD_RESUME’ representing direction of transfer |
| Local ID | The Local Agent ID assigned by FileCatalyst Central. |
| Location | The IP address of the HotFolder. |
| Remote ID | The Agent ID assigned by FileCatalyst Central to the FileCatalyst Server at the other end of the transfer. |
| Remote Location | The IP address of the server. |
| Session ID | A value created in a transfer with a FileCatalyst HotFolder which identifies which transfer task a particular file transfer is associated with |
| Transfer ID | The transfer ID assigned to this by the FileCatalyst HotFolder |
| Status | ‘SUCCESS’, ‘CANCEL’, ‘ERROR’ representing the state of the transfer upon completion |
| File Size | A positive 64-bit integer value representing the total size of the source file to be transferred |
| Data Transferred | A positive 64-bit integer value representing the amount of data actually transferred (less than total if cancelled or error) |
| Transfer Start time | Date/Time of transfer start in format yyyy/MM/dd HH:mm:ss.SSS (i.e. 2008/07/30 16:09:10.037) |
| Transfer Stop time | Date/Time of transfer stop in format yyyy/MM/dd HH:mm:ss.SSS (i.e. 2008/07/30 16:09:10.037) |
| Average Rate | A positive 32-bit floating point value representing the average data transmit/receive rate (Kbps)for the duration of the transfer |
| Peak Rate | A positive 32-bit floating point value representing the peak data transmit/receive rate (Kbps) over the duration of the transfer |
| Effective Rate | A positive 32-bit floating point value representing the effective data transmit/receive rate (Kbps) over the duration of the transfer |
| Packet Loss % | A positive 32-bit floating point value representing the packet loss percentage over the duration of the transfer |
| Remote Host | The IP address of the remote client which initiated this transfer |
| File Path | The local path which the file was transmitted or received |
| Username | The username for the server account |
| Task ID | An identifier assigned to the task that created the entry. |
| Task Name | The assigned name of the task that created the entry. |
| Report Archive Time | A positive 64-bit integer value representing milliseconds since 1970. |
Sample data report CSV file contents:
"1506545974617","My HotFolder","UDP","DOWNLOAD","915f81799658fe33","localhost.filecatalyst.net","880d126ec25347db", "127.0.0.1","M527724947687208-8-NULL","38638847","SUCCESS","35634045","0","2017/09/27 16:59:34.617","2017/09/27 16:59:34.617","0.0","0.0", "0.0","0.0","","\Koala.jpg","user","1505848701786_21712","My Task","1506546196428"
Bandwidth Report Information
| Fields | Values |
| TimeStamp | A positive 64-bit integer value representing milliseconds since 1970 |
| HotFolder | The HotFolder that is managing the transfer. |
| Remote Host | The IP address of the remote client which initiated this transfer. Value will be blank for the global sum user. |
| Report Time | Date/Time of this bandwidth snap shop in format yyyy/MM/dd HH:mm:ss.SSS (i.e. 2008/07/30 16:09:10.037) |
| Transmit Rate | A positive 32-bit floating point value representing the transmit rate (Kbps) at time of snapshot |
| Receive Rate | A positive 32-bit floating point value representing the receive rate (Kbps) at time of snapshot |
Sample bandwidth report CSV file contents:
"1217350587500","user","127.0.0.1","2008/07/29 12:56:27.500","0","85000"