Concepts of Reporting |
Content |
|||||||||||||||||
|
Supported Applications |
|
|
LabVantage supports Jaspersoft Jasper Reports and SAP Business Objects. See the LabVantage Installation Documentation for currently supported versions.
Jasper Reports |
|
|
UI Integration |
LabVantage's Jasper Report integration provides the following reporting capabilities:
• | Generate Reports from List Pages
LabVantage uses Jasper technology to convert the contents of a List page into a PDF or Excel report. See Reports and Execute Reports for more information. |
• | Create New Reports
To create Jasper Reports and use them within LabVantage, you must build the report, then register it with LabVantage (as shown in Reports and Execute Reports). Registering a report makes it a Report SDI. This means that reports are covered by LabVantage security, and can be configured from within LabVantage. To build the report, you can use a Jasper authoring tool such as Jaspersoft Studio. See Using Jaspersoft Studio with LabVantage for details. |
• | Use OOB Reports
LabVantage also provides preconfigured OOB (out-of-the-box) reports. See Reports and Execute Reports for more information. |
APIs |
M18N Support |
LabVantage provides default M18N support for all Reports. If additional support is required to be in locale/timesone/language compliance, LabVantage provides the sapphire.report.JasperReportScriplet class in the LabVantage Java Public API. Methods in this class can format dates/numbers, adjust for timezone offsets, and translate language.
If creating a Report using a client application, you must include sapphire.jar in the client CLASSPATH of the local machine.
Note that the Report will not be M18N-compliant until executed from within LabVantage.
Templates |
To assist in creating Jasper Reports, LabVantage provides templates in the options\Jasper\templates folder of the LabVantage distribution:
Template | Used in: |
LabVantageC.jrxml | Form mode. |
LabVantageT.jrxml | Table mode. |
LabVantageLandscapeT.jrxml | Landscape table mode. |
LabVantageSubreportC.jrxml | Form mode subreports. |
LabVantageSubreportT.jrxml | Table mode subreports. |
These templates automatically define:
• | Report property for the Scriplet class. |
• | Report footer containing M18N-compliant generation information. |
• | Report header (including graphic and title). |
• | System parameters. |
• | Common field-by-field properties (removing the need to do so after report generation). |
NOTE: | If Translations
are setup for static text in a Report that calls a Subreport, the static
text is translated in both the Report and the Subreport.
A set of translated Reports and Subreports are generated for each language (such as SampleDetail-Spanish.jasper and SpecificationSubReport-Spanish.jasper for a User with Spanish translations, and SampleDetail-French.jasper and SpecificationSubReport-French.jasper for a User with French translations). |
Actions |
The GenerateReport Action can:
• | Send reports directly as email. |
• | Print directly to a BO printer. |
• | Export reports to a file destination. |
Business Objects |
|
|
Overview |
Supported Report Types |
See the LabVantage Installation Documentation to determine the Business Objects versions currently supported.
LabVantage Functionality |
To work with BO reports, LabVantage provides:
Functionality | Description |
Registration | Registering a report creates a Report SDI. The report therefore has all of the advantages associated with an SDC. See Registering Reports. |
Online Viewing | LabVantage can display reports in PDF, XLS, and HTML formats. |
Background Printing | Request made to a printer accessible to the BO Server (not supported by Web Intelligence Report documents). |
Email report output. | |
Export to Disk | Export formats are defined by BO report document types (not supported by Web Intelligence Report documents). |
BO Web Services |
LabVantage uses these BO Web Services:
Web Service | Description | ||||
Session |
|
||||
BIPlatform | Allows you to administer and manage the BO platform. | ||||
ReportEngine | Controls document manipulation (prompts, passwords, opening/viewing/drilling documents served from BO Servers). |
Authentication |
Profile Properties |
LabVantage provides administrators with global (system-wide) and user (user-specific) profile properties to authenticate a user accessing BO:
Property Type | See... | Comments |
Global | Reporting Options in System Configuration | Describes all properties. |
User | User Profile in Users and Roles | Shows where to override global properties. |
Typically, the BO Administrator sets the BO Authentication Type on the BO Server. The LabVantage Administrator then sets the BO Username, BO Password and BO Authentication Type in the User Profile for each user, and the BO Authentication Type as a global property (Reporting Options in System Configuration).
LabVantage passes each user's properties to BO Web Services to authenticate and
establish a connection. Following connection, the Web Service Login function
also performs authentication. This lets you use row restriction, table mapping,
and report filtering for all users accessing reports or the report list. A successful
connection creates a session object.
Internal Authentication Process Using the BO Web Services Consumer API |
|
LabVantage passes the BO Username, Password and Authentication Type to the EnterpriseCredential class. |
|
|
LabVantage uses the EnterpriseCredential object to create a session object. |
After authenticating the user, the following steps are executed to locate and execute a report.
|
LabVantage uses the session object to create a BiPlatform object and retrieve the Response Holder object. |
|
|
LabVantage uses the session information to create the ReportEngine service for retrieving report prompts information. |
|
|
LabVantage uses the BiPlatform information to create a Response Holder object for retrieving InfoObjects from the BO Sever. Through InfoObjects, LabVantage retrieves the report in Binary format from the server (for viewing). |
|
|
The Response Holder object creates the InfoObjects object for retrieving reports from the server and scheduling to printer, email or file destination. |
|
|
The BO Scheduling Mechanism sendsthe report to printer, email, and file destination. The report is not accessed from the BO Server... LabVantage passes information to BO to send the report to a destination. | |
|
After each process is complete, the session is logged out from the BO server. |
Registering Reports |
Overview |
LabVantage recognizes a report only if you register it. Registering a report makes it a Report SDI. This means that Reports are covered by LabVantage security, and can be configured from within LabVantage. For example, you can specify how the argument is obtained from LabVantage and the user.
You can register a report only after it has been published to the BO Repository.
For details concerning the registration interface, see Reports and Execute Reports.
Internal Registration Processes |
To find the reports in the Repository, LabVantage uses the BiPlatform service and ResponseHolder objects to get a report list from a root directory.
After saving the Report SDI, LabVantage determines prompts using the BO ReportEngine service. LabVantage then saves reports and their parameters (arguments) in the database.
Viewing Reports |
Overview |
Any registered report can be executed and viewed. For details, see Reports and Execute Reports.
Internal Viewing Processes |
LabVantage processes the ReportId, corresponding BO repository path location, and prompt values in the database. When executing a report, LabVantage accesses report information from the Registered Report SDI as follows:
|
The user is authenticated and session object created. |
|||||||
|
Using the BIPlatform service, various BO objects (including the InfoObject) are used to execute the report, passing:
|
|||||||
|
After this information is passed to the BO Server, the server process it and returns DocumentInformation objects through the Report Engine. |
Scheduling Reports to Email, Printer or File |
Overview |
The GenerateReport Action can:
• | Send reports directly as email. |
• | Print directly to a BO printer. |
• | Export reports to a file destination. |
Internal Report Scheduling Processes |
The GenerateReport Action identifies the report. The ReportId and corresponding BO repository path location and prompt values for the registered report are then processed as follows:
|
The user is authenticated and session object created. |
|||||||||||||||
|
Using the BIPlatform service, various BO objects (including the InfoObject) are used to execute the report, passing:
|
|||||||||||||||
|
After this information is passed to the BO Server, the server process it and schedules to destination using BO InfoObjects. |
ConnectionTest |
A Connection Test is provided in the System Configuration User Options. These properties are replicated in the User Maintenance "User Profile" detail.
Controlled Reports |
|
|
"Controlled Reports" is a process that generates a unique event when
certain operations are performed on the report. For more information, see
Controlled
Reports.