Subscribe to PortalGuard's Quarterly Newsletter for News & Updates on the Latest Release! Click to Subscribe

How to Create Custom Reports for the Admin Dashboard Utility


Problem

You want to to view a different report via the Admin Dashboard Utility that returns information in a different configuration than one of the standard 'out-of-the-box' reports included with your PortalGuard Install.

Solution

Create a custom report xml to view via the Admin Dashboard Utility

Important Note: This article covers custom reports in PortalGuard version 6.0.0.0 and later.  If you have an older version of PortalGuard, please consider upgrading to the latest version or submit a support ticket to request assistance with creating a custom report in your version of PortalGuard. 

  1. Navigate to the PortalGuard server and open the File Explorer
  2. Navigate to C:\Program Files\PistolStar\PortalGuard\Policies\ReportDefinitions
  3. Create a new xml file using the following file name format:
    • *.report.xml
      • the * can be replaced with your chosen file name, but the extension must end in ".report.xml" to be seen by PortalGuard's reporting interface.
  4. The Report Definitions are simple XML files containing the title and SQL query that will be run against the pstar database to generate the actual report. 
    • As an example, you can edit an existing Report and modify the SQL query to create the new Report Definition.
    • In this article, we will use the "Successful Logins" Report as a starting point
  5. Edit the '1 Successful Logins.report.xml' file in Notepad++ or a similar administrative text editor
    • PortalGuard Report Definitions - Successful Logins
  6. Edit the 'display' text on line #2 to display your chosen title for the report
  7. Modify the 'query' beginning on line#4 to change what information is pulled from the pstardatabase for the new report. 
    • Data from reports are typically housed in one of the 3 following database tables:
      • EventsGeneral
      • EventsAdmin
      • EventsSSO
    • Examples of Data that can be pulled from each table can be determined in detail by viewing the table through SQL Server Management Studio
  8. For this report, we are going to add a Column which displays the Security Policy used by the user who is logging in via PortalGuard.  To do this, we add a new column in the query to return the [PolicyName] data:
    • PortalGuard Report Definitions - Custom with Policy
  9. After making the change, save the policy with a new name
    • Reports appear in the Admin Dashboard in alphabetical order, which is why the default report definition files all begin with a number.  The example above has a file name of '0 Successful Logins with Policy.report.xml', which makes it appear first in the Report Dropdown
  10. After applying the changes and authenticating to the Admin Dashboard, a new report is available which, when run, shows the security policy used by the users during login:
    • PortalGuard Activity Reporting - Custom with Policy

REV. 08/2018 | PortalGuard

  • 54
  • 29-Aug-2018
  • 320 Views