Visual Intercept Report Publisher

 



Visual Intercept Report Publisher

The Visual Intercept Report Publisher uses an XML configuration file to decide which reports to run and to whom these reports are to be sent. A single XML file can be used to publish multiple reports. In addition to being able to execute and email reports on demand, report publishing can also be scheduled, using the task scheduler provided by the Windows operating system.

Installation

To install Visual Intercept Report Publisher, simply double-click on the ReportPublisher.exe download, enter the password and follow the prompts. By default the installer will place the VisualIntercept.ReportPublisher.exe and its supporting files in the C:\Program Files\Visual Intercept Enterprise\Utilities directory.

Configuring Report Jobs

The VisualIntercept.ReportPublisher.exe operates by reading a configured ReportJob.xml file. If no file is specified on the command line, a report definition file named ReportJob.xml is assumed to exist in the same directory as the VisualIntercept.ReportPublisher.exe.

The format of the ReportJob.xml file is as follows:

Key Name Value
DSN The Visual Intercept Data Source Name used to connect Visual Intercept to the back-end DBMS
UserID A valid Visual Intercept UserID used to log on to Visual Intercept
Password A valid password for the above Visual Intercept UserID
Logging
  • 0 - None
  • 1 - Process Only
  • 2 - Process, Report Definition
  • 3 - Process, Report Definition, Export Output
FromAddress A valid Visual Intercept Administrator’s email address
ToAddress Valid email addresses delimited with semicolon (;)
CcAddress Valid email addresses delimited with semicolon (;)
BccAddress Valid email addresses delimited with semicolon (;)
Subject Text of the Subject line for the email sent to recipients
Body Text of the body for the email sent to recipients
SMTPServer SMTP Server address by name or IP
SMTPUserID SMTP UserID, if required by SMTP Server authentication
SMTPPassword Password for above SMTP UserID, if required by SMTP Server authentication

The report section contains one or more viReport definitions that tell the report job what to create. You may have as many viReport definitions as you want in this section. They follow the form as follows:

Key Name Value
Name Visual Intercept report name that you would see in the format options.
Query Visual Intercept query used to filter the data in the report.
Format Output format that your crystal installation supports. By default this is PDF.

The following shows a configured ReportJob.xml:

In the above example, the user, &dquot;isnotify,&dquot; is specified as the login ID for the &dquot;Visual Intercept Enterprise&dquot; DSN. Once the VisualIntercept.ReportPublisher.exe runs, &dquot;customer@mycompany.com” will receive an email from &dquot;support@elsitech.com.&dquot; The subject of this email will be &dquot;Report Publisher&dquot; with &dquot;This week's new Visual Intercept Incidents&dquot; in the body of that email. Attached to this email will be a PDF attachment named &dquot;New Incidents-By Status-Priority.pdf&dquot; The name of the PDF report is a combination of the Report Name and Query Name as specified in the viReport section of the XML file. These values are the same as one would find by selecting Tools|Reports in the Visual intercept Web Manager.

Running Reports on Demand

To run a set of reports on demand, simply configure the ReportJob.xml file to include those reports then double-click the VisualIntercept.ReportPublisher.exe.

Running Reports on a Schedule

To run a report on a pre-determined schedule you would simply use the operating system’s Scheduled Tasks functionality. Select the Add Scheduled Task option from the Start|Settings|Control Panel|Scheduled Tasks option. Follow through the wizard, browsing to and selecting the C:\Program Files\Visual Intercept Enterprise\Utilities\VisualIntercept.ReportPublisher.exe as the program to run. The VisualIntercept.ReportPublisher.exe will read the ReportJob.xml that is in the same directory as the executable to determine which reports to run.

If you have other questions about issues not included in or beyond the scope of this Tech Tip, please contact Elsinore Technical Support Services at or 866.866.0034, option 2.