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

PortalGuard Reporting Extension information and installation

The PortalGuard Reporting extension is a set of UI files and a configurable backend service that runs on your PortalGuard server.  It allows you to use the canned reports found on the admin dashboard to create scheduled reports that run on daily, weekly, or monthly intervals.  The results of these reports are sent to a specified list of email address as an attached comma separated value file.  The results of the report are queried within the frequency of the report.  For example, a daily report run on 1 AM 5/14/2019 will take all results from 1 AM 5/13/2019 and onward.

You can also test your reports without waiting.  Use the "run all reports" button on the PG Reporting Manager.

Run time intervals

  • Daily - 1 AM every day
  • Weekly - 1 AM on the specified weekly run date
  • Monthly - 1 AM on the first of the month

Customization

PGReporting allows for several customizations.  They can be set using the service installation utility(May be changed to web.config in future).

These customizable fields include:

  • SMTPServer - SMTP server name for sending scheduled emails.
  • SMTPPort - SMTP port number for sending scheduled emails.
  • SMTPUser - SMTP username for sending scheduled emails.
  • SMTPPass - Password for the provided SMTPUser.
  • EmailFrom - From address of all email reports sent.
  • EmailSubj - Subject line of all email reports sent. {0} = Report Title placeholder, {1} = DateTime run placeholder.
  • EmailBody - Email body text of all email reports sent.
  • WeeklyRunDay - Day of the week to run weekly reports on.
  • ReportPath - System file path of your canned reports.
  • pstarConnectionString - SQL connection string for your reporting_user.

Installation

  1. Copy the "Reporting" folder into Inetpub/Portalguard/Exts.
  2. Copy "PGReporting.dll" and "HtmlSanitizationLibrary.dll" into Inetpub/Portalguard/Bin.
  3. Run upgrade-for-reporting.sql to set up the required tables and stored procedures.
  4. Create a new DB user for table extScheduledReports to read/write and run stored procedures.
  5. Add the line: "<add name="ReportAuthz" type="PGReporting.ReportAuthz, PGReporting" preCondition="managedHandler"/>" to your root web.config in the <modules> section.
  6. Add the connection string for your database and user in your reporting web.config within the enclosing <connectionStrings> tags.  Example: "<add name="Reporting" connectionString="Data Source=YOURSERVER\YOURSQL;Initial Catalog=pstar;User Id=reporting_user;Password=catdog123!@!@" />"
  7. Add your users who should have access to the extension within the <AllowedUsers> tags in the reporting web.config.
  8. Use installer.exe to configure settings and install/start service.
  • 105
  • 03-Jul-2019
  • 52 Views