Reporting |
Filter descriptions for reporting
Aspera Console provides built-in filters that allow you to specify conditions for limiting the data included in your report. The filters section includes the following columns:
Column Heading | Description |
---|---|
Filter By | Select from a list of parameter names. |
NOT | Appears as a checkbox, where unchecked represents "is" and checked represents "is not" (e.g. file extension is not equal to tmp) |
Comparison | Select from a list of operators (e.g., equal to, greater than, etc.). |
Value | Input a parameter value to complete the filter expression. |
Once you have added a filter, you may remove it by clicking the Remove hyperlink.
The following filter parameters are available within the "Filter By" drop-down list:
Parameter Name | Parameter Description |
---|---|
{Custom Field Names} | Displays custom fields that you have configured for the SQL database. |
File Bytes Transferred | File bytes successfully received over the network by the destination. |
File Bytes Written | Files bytes successfully received over the network by the destination, plus bytes skipped for data already present at the destination. |
File Error Description | File's error message, if any. |
File Extension | Portion of the filename after the last period (.) |
File Fullpath | File's directory tree hierarchy. |
File Name | Name of the file, without its path (e.g. "my_file.txt," rather than "C:\temp\my_file.txt"). |
File Session Status | Status of file session (e.g. "running," "completed," "canceled" or "error"), where a file session is one file in a transfer session. A file record may group together more than one file session record if, during a transfer session, one of the files fails or is interrupted. In the next transfer session (when the transfer is retried or a hot folder handles the next batch of files to arrive), then that particular file may be retried. This will result in another file session record being created. |
File Size | Size of the file in bytes. |
File Status | The file status will be the status of the last/most recent file session for the file (e.g. "running," "completed," "canceled" or "error"). |
SSH Account | SSH account specified when the transfer starts. |
Transfer Average Rate | Average transfer rate in bits per second. |
Transfer Bytes Lost | Number of bytes sent by source for a particular file, but never received by destination, or never written to disk. |
Transfer Bytes Transferred | Total bytes successfully received over the network by the destination. |
Transfer Bytes Written | Total bytes successfully received over the network by the destination, plus bytes skipped for data already present at the destination. |
Transfer Client Address | IP address of transfer initiator. |
Transfer Contact | Contact assigned by Console. This can be a Console user name, a Faspex user name, SSH account, or customized value obtained from a transfer cookie. Examples: "admin (console)", "aspera (ssh)", "michael (faspex)" |
Transfer Cookie | Custom identifying text attached to a transfer session. This text is used by the Console to identify and name transfers. |
Transfer Destination Address | IP address of transfer destination. |
Transfer Destination Path | The file path on the destination machine. |
Transfer Error Description | Error message for transfer or file, if any. |
Transfer Files Completed | Number of files successfully verified at destination (i.e., the number of files actually transferred plus the number of files that were already at destination). |
Transfer Files Failed | Number of files that failed to transfer. |
Transfer Name | Human-readable name assigned to a transfer. This name may have been keyed in by the user or automatically set by an application. |
Transfer Server Address | IP address of transfer server. |
Transfer Session Status | Indicates status of transfer session (e.g. "running," "completed," "canceled" or "error"), where the transfer session represents one execution of ascp (i.e., one attempt to transfer). Note that when a transfer session is interrupted or fails and is configured to retry, a second transfer session will begin after the configured retry interval has elapsed. |
Transfer Source Address | IP address of transfer source. |
Transfer Source Paths | File paths on the source machine. |
Transfer Status | Note:
A transfer groups together transfer sessions into a single item. The transfer status will be the status of the last/most recent transfer session for the transfer (e.g. "running," "completed," "canceled" or "error"). |