Basic Report Example: Faspex Metadata

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.

Note: This example assumes that the "event" (metadata) field has already been set up on the Faspex node. When creating a new Faspex package, Faspex users can select from a predefined (drop-down) list of events, which populates the database for this custom field.

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.

  1. Set up a Console database custom field for the metadata.

    Within Console, select Configuration from the main menu, and then the Custom Fields tab. Create a new, custom field with the following attributes:

    • Level: Select "transfer"
    • Name: Enter the name "event"
    • Start Date: Enter "2011-01-01"
    • Description: Since this custom field is for the metadata report, enter the description "Faspex Metadata report demo"

    For more information on custom fields, see Creating Custom Fields.

  2. 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
  3. Create a custom rule for the Faspex Metadata transfer field.
    • Built-in field: Faspex Metadata
    • Operator: JSON match
    • Expression: \{.*"Event":"(?<event>.+?)".*\)
    • "faspex_event" custom field value: <event>.

    In other words, if the Faspex Metadata JSON matches the expression, then set the custom field value to the value of <event>. So, if the Faspex metadata is {"Event":"Summer","_pkg_uuid":"abde20e28db24bfdb513c0a3de3bb8ff", "pkg_name":"test"...}, the "faspex_event" custom field's value is Summer.

    The expression is interpreted as follows:
    Expression Interpretation Characters matched in the example
    \{ Finds a left curly bracket character {
    .* Followed by 0 or more characters until the next piece of the expression ("Event":")  
    "Event":" Followed by the first match of the exact text "Event":" "EVENT":"
    (?<event>.+?) Followed by at least 1 character" (save these characters and call them <event>) Summer
    " Followed by a quotation mark "
    .* Followed by 0 or more characters until the next piece of the expression (\{) ,"_pkg_uuid":"abde20e28db24bfdb513c0a3de3bb8ff", "pkg_name":"test"...
    \} Followed by a right curly bracket character }
  4. Go to the Manage Report Types page.

    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.

  5. Configure your basic report to display contact, file-level, and transfer-level details, organized by Faspex metadata (the "event").

    On the Create New Report Type page (for basic reports), enter the following information:



    Field Description
    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:
    • Event (Based on a transfer-level rule that states if the conditions match the regular expression, then set the "event" custom field value to the Faspex metadata value.)
    • 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)".)
    • Transfer (Human-readable name assigned to a transfer. A transfer represents one or multiple executions of ascp (i.e., one or multiple attempts to transfer).)
    • File (File's name)
    Columns to include Select the following basic fields to include as columns:
    • started at
    • stopped at
    • bytes transferred
    • status
    • average rate
    • cookie
    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:
    • Sort your metadata groups by event/metadata name
    • Sort your contact groups by contact name
    • Sort your transfer groups by transfer name
    • Sort your file groups by file name

    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).
  6. Save, finalize run settings and run your report.

    Next, click the Create and Run button. Confirm the following settings on next page:

    • Title is as described above.
    • Report is scheduled to Run Now.
    • Report period is Month to date and time zone is Pacific.
    • Sorting is as described above.
    • Filter is as described above.

    Once confirmed, click the Run Report button.

  7. View your Web report.

    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:

    • Metadata
    • Faspex Users that selected the corresponding event/metadata
    • Transfers (per Faspex User), which are sorted by the time they started
    • File name (per Transfer)

    In addition, all data columns appear as selected on the Create Basic Report Type page.