1. Home
  2. Reporting
  3. How to create a new custom report

How to create a new custom report

You can create new reports using SQL and parameters. Using parameters in your SQL query allows you to run the same report against different values instead of creating multiple reports.

To create a new report:
  1. Log in to Admin Portal.
  2. Click Reports > New Report.
  3. Enter a name for your report.Names can contain letters, numbers, and underscores. Do not include special characters or white space.
  4. Configure the report options:
    • Report can be displayed on a map — Enable this option to display the data on a map if the report is location related.
    • Validate report on save (enabled by default) — Enable this option to validate the SQL syntax when you save the report.
  5. Click Script Editor.
  6. Enter the SQL query to define what you want the report to display.Write SQL queries that use parameters for arguments rather than concrete values. This will allow you to run the same report against different values. For example, you can write the following SQL query:select username, lastlogin from user where username like @userParam

    You now must define the “userParam” parameter to make use of the query.

  7. Click Parameters to specify parameters.Parameters allow you to define a report with different values. Parameters you specify must be paired with your SQL query. In our example, the SQL query in the above step uses the “userParam” parameter, so you must define the same parameter here.
  8. Click Save.Admin Portal saves your report in the My Reports folder.

When you run the report, you will be prompted for the parameter value/s that correspond to the parameter/s you have defined. For example, you can enter d% to get usernames starting with the letter “d” if you have defined a username parameter and written a corresponding SQL query.

Updated on April 9, 2018

Related Articles