Custom reports are database objects and attributes you specify for querying MOVEit Transfer performance and status data, formatting the results, and saving the resulting report.

To define a custom report, you define a custom query. Knowledge of the data available and of the SQL query language is required. For information about the database schema available to MOVEit Transfer, see the topic Database Schema.

Both basic and custom reports can be added, edited, executed, and deleted. For more information about basic report management, see the topic titled Reports.

Custom reports can be exported and imported, so you can share them between systems, MOVEit Transfer administrators, and MOVEit support personnel.

Adding a Custom Report

  1. In the navigation pane, click REPORTS. The Reports page opens.
  2. In the Add Report... section, in the Report Category dropdown, select Custom.
  3. Make a selection:
    • Create from scratch.
    • Create from existing. Click Choose File and select the existing report on which to base the new report. The Edit Report page opens.

Custom reports can exported and imported. This allows custom reports to be easily shared between systems, and between MOVEit Transfer 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

After you create a custom report, you can edit the

Custom Report Configuration Options

Custom Report configuration options expect object attribute names. For example, for a custom Storage Report, you can retrieve the value for a file's time stamp (contained in the UploadStamp attribute) by using the following syntax applied to the Fields input:

Files.UploadStamp —Where UploadStamp is an attribute name (literal) of the Files data object.
Note: For more information on data objects (Users, Files, Folders, and so on), you can see the topic titled Partial Schema.
  • Name, Report Type, Format, Run On Days, Save In Folder, and Save As File options work the same way, in addition to the CSV-specific options. Report parameters differ from built-in reports parameters. The six available parameters define the data query that will be performed against the MOVEit Transfer 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, prefix each field by its table name.

    Fields Example 1:

    Users.Username (You must provide at least one field.)

    Fields Example 2:

    Users.Username,Files.FolderID,Files.UploadStamp (Where you separate multiple fields using a comma, as shown.)
  • Tables - Specifies the database tables to be queried, and how to join those tables to each other for the proper results.

    Example:

    Get the RealName field for a user account that uploaded a file, use the following:

    "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.

    Example:

    Return users who are not marked as deleted:

    "Users.Deleted='0'"

    (Multiple criteria statements can applied using the "AND" keyword.)
  • Grouping - Determines how results should be grouped, if desired. This is analogous to the "GROUP BY" clause in an SQL query.

    Example:

    To group by account usernames, use the following:

    "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.

    Example:

    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 appears 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 using the process above. Click Export Report to generate an export file and send it to a browser, where it can be downloaded.

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