Web Interface - Reports - Custom Reports

Custom reports are similar to other reports in that they are sets of instructions for querying MOVEit DMZ's performance and status data, formatting the results, and saving the resulting report. Where other report categories and types execute pre-defined queries, however, custom reports provide the ability to define a custom query, allowing reports of any type to be created based on the data available. Knowing what data is available and how to request it is obviously a requisite to constructing useful custom reports. Knowledge of the SQL data querying language is also important. For information about the database schemas available to MOVEit DMZ, see the Database Schema page.

Managing custom reports is mostly the same as managing other reports. Custom reports may be added, edited, executed, and deleted. For more information about basic management of reports, see the Reports Overview page.

Adding a Custom Report

In addition to basic management, custom reports may also be exported and imported. This allows custom reports to be easily shared between systems, and between DMZ administrators and MOVEit support personnel. As a result, the process for adding a custom report looks slightly different than other report types. Upon choosing to add a custom report, additional options will be displayed asking if the new report should be created from scratch, or imported from an existing report file.

Electing to create a new report from scratch will lead to the Add Report page, as with other report types. Electing to create from an existing report file will cause a file browse box to be displayed. Use this to select the report file to import. A successful import will lead to the Edit Report page, where additional options may be configured.

Editing a Custom Report

Most configuration options are the same for both built-in reports and custom reports. The Name, Format, Run On Days, Save In Folder, and Save As File options work the same way, as well as the CSV-specific options. The report parameters, however, are quite different from those available to built-in reports. The six available parameters define the data query that will be performed against MOVEit DMZ's database in order to gather the desired information for the report:

• Fields - Determines which fields will be requested during the query. If a report will be querying data from more than one database table, each field should be prefixed by its table name. For example, "Users.Username" or "Files.FolderID". Multiple fields should be separated by commas. This parameter is required.
• Tables - Determines which database tables will be queried, and how those tables should be joined to each other in order to get the proper results. For example, to get the RealName field for a user account that uploaded a file, use "Files LEFT JOIN Users ON Files.UploadUsername=Users.Username". This parameter is required.
• Criteria - Determines which data rows will be returned by the query. This is analogous to the "WHERE" clause in an SQL query. For example, to only return users who are not marked as deleted, use "Users.Deleted='0'". Multiple criteria statements should be separated by the "AND" keyword.
• Grouping - Determines how results should be grouped, if desired. This is analogous to the "GROUP BY" clause in an SQL query. For example, to group by account usernames, use "Users.Username".
• Order - Determines the order in which the results will be returned. This is analogous to the "ORDER BY" clause in an SQL query. Use the "ASC" keyword to order in an ascending fashion, and the "DESC" keyword to order in a descending fashion. For example, to order by account usernames alphabetically in an ascending fashion, use "Users.Username ASC".
• Limit - Limits the number of results to the specified number. If blank, all results will be returned.

Operators such as the minus sign normally apply to all times and dates in a macro phrase. To apply operators to only part of a macro phrase, use single-quotes or double-quotes to delimit phrases. For example, if today is currently July 5, 2007, a macro of:

• [dd][mm-][yyyy] TO [dd][mm][yyyy] yields 05062007 TO 05062007
• "[dd][mm-][yyyy]" TO "[dd][mm][yyyy]" yields "05062007" TO "05072007"

Exporting a Custom Report

In addition to the Run Report section, the Export Report section will also be shown on the Edit Report page for custom reports. This allows the current report definition to be exported to a file, which can then be imported via the process above. Pressing the Export Report button will cause an export file to be generated and sent to the browser, from where it can be downloaded to a local file.

NOTE: Only the name and custom query definition fields are exported. Information such as format, run times, and folder to save to are not included in export files, as they are generally unique to the system.