/
Install ServiceAnalytics Before you Start
Document toolboxDocument toolbox

Install ServiceAnalytics Before you Start

Owned by Paul Hindle
Last updated: Feb 26, 2018 by f.anwar (Deactivated)Version comment

On This Page:

 

ServiceAnalytics is a value-added module available within ServiceManager. ServiceAnalytics uses CrystalReportsTM to provide reporting functionality.  It can either be run as a bundled module, or it can access reports through BusinessObjects Crystal Reports ServerTM.  Please note that only one version of ServiceAnalytics can be installed and the two installations are incompatible, so it is not possible to have both in the same installation of ServiceManager.  

Selecting which version to deploy

The ServiceAnalytics release contains both the Standard and Crystal Reports Server (CRS) versions of ServiceAnalytics, both versions have compressed (ZIP) archives and, for the Windows platform, an MSI installation format. 

Standard Version

Using Crystal Reports’ Crystal Reports for Java API (CRJ) the Standard deployment of ServiceAnalytics executes reports locally within the application server hosting the ServiceManager application.  The CRJ does not require access to a Crystal Report Server, and requires no additional licensing from SAP Business Objects.  The standard version offers basic reporting. Reports may be printed and also saved in various formats including PDF, CSV, RTF and Microsoft Excel and Word.

Note: Standard version & Oracle DB

When the standard version of Analytics is installed against an Oracle database, the sp083 parameter sm_rpt_stringBasedSAAudit must be set to 'YES'.

This will force Analytics to convert dates to strings in the server for the SA Audit report which is necessary to run on Oracle.

Crystal Reports Server version

The Crystal Reports Server version of ServiceAnalytics requires integration with Crystal Reports Server and provides a number of benefits[1] that are not available within the embedded solution provided by the standard version ServiceAnalytics.  These include the ability for users to schedule and email the reports.  Reports may also be saved in XML format. 

Custom reports may be integrated into ServiceAnalytics in either version. However, using the Crystal Reports Server version adds the ability to provide Dynamic (and Cascading) parameters, which is not available in the Standard version.

Pre-requisites

ServiceAnalytics must be installed with a compatible version of ServiceManager - see ServiceManager Pre-requisites.

Components

ServiceAnalytics is a module of ServiceManager, which provides reporting capability. ServiceAnalytics uses the ServiceManager database connection pool to connect to the database and retrieve the necessary data for each report. This data is used by a third party tool, Crystal Reports™, to display the reports.

Integrating with ServiceManager

Whenever a ServiceManager module is installed, upgraded or uninstalled, the appropriate process must be followed as described in the following sections. The ServiceManager application will then need to be restarted twice, to ensure that the correct ServiceManager modules are fully installed and initialised.

Unpacking

Regardless of the ServiceAnalytics version (Standard or Crystal Reports Server), and whether installing from the MSI application or from one of the provided ZIP files, the resulting directory and file structure on the target machine will be the same.  The main difference in installation of ServiceAnalytics between the MSI application and manual (ZIP) extraction is the requirement for the user to update the Crystal Reports™ configuration file after the extraction. The MSI applications use information that was supplied during the MSI installation of ServiceManager and requires no subsequent manual editing of these files.

The following diagram represents the directory structure installed on the target machine.The top directory in this diagram must be placed in ServiceManager’s modules directory.

 

ServiceAnalytics rlease contents
/modules[1]
	/SERVICEAnalytics[2]
		/coreReports
			/crystalreportviewers[3]
		/WEB-INF
			/lib
				*.jar[5]
			/classes
				CRConfig.xml[4]

Where:

[1]            This is ServiceManager’s modules directory

[2]            This directory should be directly under ServiceManager’s modules directory.

[3]           CrystalReports™ Reporting Engine

[4]            Crystal Report Configuration file

[5]            Crystal Report Java files