The following instructions demonstrate how to configure new, advanced reports. To view an example of an advanced report, you may refer to the topic Example 4: Transfer Sessions with High Packet Loss. If you would like to learn more about creating basic reports within Console, you may refer to the topic Creating a Basic Report.

  1. Navigate to the Manage Report Types page

    To create a new, advanced report, select Reports from the Console menu, and then click the Manage Report Types button.

    On the Manage Report Types screen, click the New Advanced button.

    IMPORTANT NOTE: You may also modify an advanced report by clicking the edit action for a report that is listed on the Manage Report Types page.

  2. Configure your advanced report

    After clicking the New Advanced button, you will be directed to the Create New Advanced Report Type page.

    IMPORTANT NOTE: When creating advanced reports, you may specify a custom/configurable variable within the WHERE clause (e.g. $ANYTHING_ELSE). Once declared within the SQL script text, you will be able to view and/or edit the variable by clicking the Edit Parameters button on the Edit Advanced Report Template page. If the custom/configurable variable is not required and it is used with the AND operator, then the report query should be written like the following example:

    ...
    WHERE
    ...
     AND (
       t.status = '$FOO'
       OR '$FOO' = ''
     )
    ...
    
    Failure to include
    OR '$FOO' = ''
    will result in an empty report because the data will be filtered by
    t.status = ''
    (which is always false)

    The following configuration options are available on the Create New Advanced Report Type page:

    Field Description
    Report Name Input a descriptive name for your report (note that you are limited to 75 characters).
    Report Description Input additional details about the report.
    SQL Script Text Input your SQL script into this field (which is initially populated by default). For information on available SQL variables or database field references, click on Help link next to the input box. SQL variable and database field reference help is also available in this user guide. Please refer to topics Advanced: SQL Variables and Advanced: Database Field References, respectively.

    Filters can also be added to Advanced Reports within the WHERE section of your script, as shown in the example below:

    ...
    WHERE
     ts.reported_policy IS NOT NULL
      AND
       ts.started_at < '$REPORT_PERIOD_END'
       AND (
    	ts.stopped_at >= '$REPORT_PERIOD_START'
    	OR ts.stopped_at IS NULL
      )
    ...
    

    The example script filters out transfers that do not have a reported policy, as well as those that do not fall within the requisite date range.

  3. Create (and optionally run) your report

    Once you have finished configuring your advanced report, click the Create button to save the report, or Create and Run to save and then proceed to finalizing the run settings. If you click Create, the report will be saved on the Manage Report Types page. Under the Custom Reports section, you may click edit to modify the report, copy to duplicate the report, run to view run settings and then generate the report, or delete to remove the report from Console. Alternatively, if you click Create and Run, the report will be saved on the Manage Report Types page, as well as automatically run by Console. Note that you must finalize the report's run settings before the report is generated.

    Proceed to the topic Finalize and Run a Report for information on finalizing the report's run settings.