Console allows you to create and export custom reports, as well as apply filters and scheduling options. The steps below demonstrate how to configure new, basic reports. To view an example of a basic report, see the three samples in this topic.To learn about creating advanced reports within Console, see the topic Creating an Advanced Report.
Navigate to the Manage Report Types page
To create a new basic report, select Reports from the Console menu, and then click the Manage Report Types button.
On the Manage Report Types screen, click the New Basic button.
IMPORTANT NOTE: To create an advanced report, click the New Advanced button instead. You can also copy and edit Console's built-in, advanced reports, which are listed on the Manage Report Types page. For further information on advanced reporting, see Creating an Advanced Report.
Configure your basic report
After clicking New Basic, you will be directed to the Create New Report Type page (for basic reports).
The following configuration options are available on the Create New Report Type page (for basic reports):
Field Description Name Input a descriptive name for your report (note that you are limited to 75 characters). Description Input additional details about the report. How would you like to organize this report? Select a field from the drop-down list that will be used as the basis of organization for your report. The drop-down list features built-in fields, as well as custom fields that have been added via Console's configuration menu. Built-in fields include the following:
- Client Address (IP address of transfer initiator)
- Contact (Contact assigned by Console. This can be a Console user name, a Faspex Server user name, SSH account, or customized value obtained from a transfer cookie. Examples: "admin (console)", "aspera (ssh)", "michael (faspex)".)
- File (File's name)
- File Extension (File's extension)
- Server Address (IP address of the transfer server)
- Session (Human-readable name assigned to a transfer session. A transfer session represents one execution of ascp (i.e., one attempt to transfer).)
- Transfer (Human-readable name assigned to a transfer. This name may have been keyed in by the user or automatically set by an application.)
The data in the generated report will be grouped (in ascending order) by the field that you select from the drop-down list. For example, if Client Address is selected, then the data in the report will be grouped by the transfer initiators' IP addresses (e.g. 5 transfers initiated by 10.168.1.1 in the first grouping, 3 transfers initiated by 10.168.1.2 in the second grouping, etc.)
IMPORTANT NOTE: Once a field is selected, the drop-down list updates automatically to allow for multiple levels of organization. If you would like to remove a level of organization, click the Remove link that appears next to the selected field.
Columns to include Select the data columns to include in your report (includes built-in and custom fields). You may choose from basic fields only, or basic and advanced fields. Please note that columns available in this drop-down list are determined by the organization fields selected above. Upon selecting a data column, the field's definition will appear in the box below. Sort Identify the fields to sort by inside your groups (which appear based on the data columns that you chose to include in your report), as well as whether to sort your data in ascending or descending order. Please note that the report--by default--will be sorted by the organization field(s) that you selected above. Filters To narrow down the report, specify the filter and value to show only the matching result. For detailed information on Console's filters, please refer to Filters.
Create (and optionally run) your report
Once you have finished configuring your basic report, click the Create button to save the report. The report is then listed on the Manage Report Types page. Custom reports are listed with edit and delete links and are thereby distinguishable from Console's built-in reports. Both custom reports and built-in reports include a copy link to duplicate the report, and a run link to view run settings and then generate the report.
Alternatively, if you click Create and Run, the report is automatically run by Console as well as saved. Note, however, that you must finalize the report's run settings before a report is generated.
Proceed to the topic Finalize and Run a Report for information on finalizing the report's run settings.