|Appendix / Example Reports|
The following example demonstrates the process of creating a new, basic report (following the instructions described in the topic Creating a Basic Report) for Faspex metadata. In our example, we will generate a report that displays the metadata that is entered into a "Create New Package" form within Faspex, which is accomplished by creating a new, custom field called "Event" within Console.
The example report, once generated, will display the purpose (or "Event") of the Faspex package, as well as file-level detail, transfer-level detail (where a transfer groups together transfer sessions into a single item), and which Faspex user sent the package.
Within Console, select Configuration from the main menu, and then the Custom Fields tab. Create a new, custom field with the following attributes:
For more information on custom fields, see Creating Custom Fields.
|Built-in field||Faspex Metadata|
|Operator||matching regular expression|
|Custom Field Value||<event>|
In the rule example above, a rule is created that states if the conditions match the regular expression, then set the "event" custom field value to the Faspex metadata value.
The regular expression is interpreted as follows:
The following example of decoded metadata for a Faspex cookie shows what the regular expression matches:
When finished, click Create to create the new rule.
On the next page, click the Back to Custom Fields tab or the Custom Fields tab. Locate the entry for the field you just created ("event" in this case), and click recalculate.
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.
On the Create New Report Type page (for basic reports), enter the following information:
|Name||Faspex meta data report|
|Description||Based on the custom field "event." Includes metadata, contact, file-level, and transfer-level details.|
|How would you like to organize this report?||Select "Event" (which is a custom field), "Contact," "Transfer"
and "File" as the fields by which to organize this report. In doing
so, the report will be grouped by the following:
|Columns to include||Select the following basic fields to include as columns:
Note: When you select a field, its definition will appear in the box below.
|Sort||Select the following fields to sort data inside your groups:
Select ascending order for all fields.
|Filters||Filter the report so that only fields with metadata appear (that is, event is not NULL) and only data from Faspex Users is displayed (that is, transfer contact contains the value faspex).|
Next, click the Create and Run button. Confirm the following settings on next page:
Once confirmed, click the Run Report button.
After clicking the Run Report button, the page will update to display the report queuing and then running. Once generated, the Web version of your basic report will appear as shown below.
As you can see, the report's data is grouped and sorted in the following manner:
In addition, all data columns appear as selected on the Create Basic Report Type page.