Report Service

Overview

The Report Service generates scheduled and on-demand reports from SBN. On a fixed timer it pulls the next batch of queued report requests, runs each one against the Crystal Reports engine, and writes the finished output (typically PDF) to a destination folder so it can be delivered or emailed. It can run several reports at once and includes a serial number so multiple Report Services can share the same queue without processing the same request twice.

The service can optionally write the underlying report data out as XML, and it keeps its own working folders for report definition files, generated output, and dealer-branding images. Because reporting depends on the Crystal Reports engine, the matching Crystal Reports runtime must be installed on the machine before the service will start — see Crystal Reports Runtime. The Report Service requires a working SBN data-server connection; if that connection or the Crystal Reports runtime is missing at start-up, the service logs the reason and stops.

Service Manager

Instructions for installing and interacting with this service is found here.

Service Properties

Only properties specific to this service are listed here. Common service properties (SBN Server connection, Logging, SMTP) are found here.

Serial Number

Identifies this Report Service when several share the same report queue, so each request is processed by only one service.

Max Runs

The maximum number of reports the service will process at the same time. A value greater than 1 lets the service run reports in parallel.

Timer (In Seconds)

How often the service checks the queue for new report requests.

Cleanup Timer (In Seconds)

If no report has been processed for this long, the service clears any request that may have become stuck mid-run so it can be picked up again.

Crystal Reports File Path

Folder containing the Crystal Reports definition files the service runs. The folder is created automatically on start-up if it does not already exist.

Report Destination Path

Folder where finished report output (such as PDFs) is written. The folder is created automatically on start-up if it does not already exist.

XML Path

Folder where report data is written as XML when XML output is enabled. The folder is created automatically on start-up if it does not already exist.

Image Path

Folder where dealer-branding images used on reports are stored. The service refreshes these images periodically. The folder is created automatically on start-up if it does not already exist.

Write XML

When checked, the service also writes the report data out as an XML file.

Include XML Schema

When checked, the XML output includes its schema definition.

Crystal Reports Runtime Path

The Report Service requires the Crystal Reports runtime to be installed on the machine. On the File Paths tab the detected runtime location is shown, with a Discover button to locate the installed runtime and a Clear button to reset it (the service will re-detect on the next start). For installing the correct runtime, see Crystal Reports Runtime.

Email notification to

The email address that receives an alert when a report runs longer than the threshold below. SMTP server settings themselves are not configured here — they are defined in the Email Report service — so only the recipient and threshold are set on this service.

When a report runs longer than (minutes)

If a report takes longer than this many minutes to run, a notification email is sent to the address above.

Stability Improvements

Memory and thread handling in the Report Service was improved for greater stability.