======================================================================
Halcyon PrimeAlert (R) Enterprise Reporter
Version 1.1.0
README.install
-----------------------------------------------------------------------
Overview
======================================================================
This README.install file describes how to install and setup
PrimeAlert Enterprise Reporter.
It consists of the following sections:
- Definitions
- Before You Install
- Extracting the Distribution
- Installation Instructions
. Server Packages (Solaris)
- Uninstallation Instructions
. Server Packages (Solaris)
- Install & Uninstall Logs
Definitions
======================================================================
Server Host The host where the Sun Management Center (Sun MC) Server
is installed and running. This system must be a Solaris
host and have the package SUNWessrv installed.
ESROOT For Sun Management Center (Sun MC) 3.5 or higher, this
directory is determined by the user while installing
Sun MC; the default value is /opt/SUNWsymon. To
determine the value of ESROOT on a Sun MC agent host,
run the command (for Solaris 10+ zoned environment,
run the following command in a non-sparse root zone):
# echo "`pkgparam SUNWesagt BASEDIR`/SUNWsymon"
LOCALDIR The configuration and logfile directory specified during
installation. To determine [LOCALDIR] after installation,
issue the command on a Solaris host:
# pkgparam HALmmserp LOCALDIR
Before You Install
======================================================================
To install PrimeAlert Enterprise Reporter to work with Sun Management
Center, a Sun Management Center server must be installed, configured,
and running on the host where you install Enterprise Reporter.
If the PrimeAlert WebPortal or PrimeAlert Reporter is already installed
on the host where PrimeAlert Enterprise Reporter is to be installed, it
is recommended to restart them because some shared packages might be
upgraded.
During installation the user can select the underlying database that
should be used by Enterprise Reporter. The following options are
available:
- PostgreSQL: If selected the bundled PostgreSQL database
management system is installed and configured for use with
Enterprise Reporter.
- Oracle: If selected the installation script will ask for the
database parameters (host, port, service name, user, password).
IMPORTANT NOTE:
Before Enterprise Reporter is started it is essential to
execute the provided SQL script on the Oracle database server
to create all required tables for Enterprise Reporter. Please
refer to the README.oracle file for more information.
If PostgreSQL is selected the installation script will also ask whether
default report templates should be installed. For installations that
use Oracle as their database these templates can be installed using the
following script in the root of the extracted distribution file:
- insert_report_templates.sql
In order to login to Enterprise Reporter the user must be configured
in the /etc/passwd, /etc/group, and /etc/shadow files. Additionally,
the user must be part of at least one of the following groups:
- eruser: regular user without administrative privileges
- eroper: user with administrative privileges of objects
owned by the user
- eradmin: user with administrative privileges of objects
owned by any user
Extracting the Distribution File
======================================================================
The PrimeAlert Enterprise Reporter distribution file,
HALEnterpriseReporter_[version].tar.gz
must be extracted on a UNIX host before any packages can be installed.
For example, assume that the distribution file has been copied to the
following directory
/tmp
In this case, the procedure for extracting the distribution will be:
% su -
# cd /tmp
# gzip -d HALEnterpriseReporter_[version].tar.gz
# tar xvf HALEnterpriseReporter_[version].tar
Following the example above, the source directory [EXTRACT_DIR] would
be the following:
/tmp/HALEnterpriseReporter_[version]
Installation Instructions
======================================================================
This product may be installed using Halcyon's standard installation
method or with Sun Management Center's Agent Update feature. To
install the product with Agent Update, refer to the instructions in
the following file:
./AgentUpdate/README-AgentUpdate.html
or
http://www.halcyoninc.com/support/README-AgentUpdate.html
NOTE:
If you choose to use Agent Update, then all Halcyon products must be
installed using Agent Update. It is not possible to use Agent
Update in conjunction with any other installation procedure.
To install the product with Halcyon's standard installation method,
continue with the instructions outlined in this section.
There is one required step to install this product:
1. Install the Server host packages
1. Server Packages (Solaris)
----------------------------------------------------------------------
To install the "PrimeAlert Enterprise Reporter" packages on the Sun
Management Center Server host, do the following:
1. Become the "root" user on the Server host
2. Extract the distribution file
3. Run the install script
% su -
# cd [EXTRACT_DIR] (i.e. /tmp/HALEnterpriseReporter_[version])
# ./HALEnterpriseReporter-install.sh
After the packages are installed, start the Apache Tomcat server by
issuing the commands:
% su -
# $ESROOT/HALmmserp/bin/ereporter start
Point your web browser to the URL indicated during installation to
begin using the PrimeAlert Enterprise Reporter.
Uninstallation Instructions
======================================================================
NOTE: If the Halcyon products have been installed using Agent Update,
then Sun's [ESROOT]/sbin/es-uninst script MUST be used to
remove the Halcyon products. If the products have been
installed using Halcyon's installation method, continue with the
instructions outlined in this section.
This section explains how to uninstall the various PrimeAlert
Enterprise Reporter components:
1. Uninstall the Server host packages
In general, the uninstall script can be used with no arguments to
uninstall any Halcyon PrimeAlert product:
# /var/opt/SUNWsymon/uninstall/HALUninstall.sh
Uninstall Server Packages (Solaris)
----------------------------------------------------------------------
To uninstall the PrimeAlert Enterprise Reporter packages on the Sun
Management Center Server host, do the following:
1. Become the "root" user on the Server host
2. Run the uninstall script with the appropriate parameters
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module EnterpriseReporter server
Enterprise Reporter keeps its data in the following directory:
/var/opt/SUNWsymon/HALEnterpriseReporter
This directory contains the following sub-directories:
- conf: Enterprise Reporter configuration files
- logs: Enterprise Reporter log files
- lib, webapps: Enterprise Reporter web application
- temp, work: temporary Tomcat files
- postgresql-[version]: PostgreSQL distribution
- db: PostgreSQL database files with Enterprise Reporter data
Uninstalling Enterprise Reporter will leave these directories intact.
Remove any of them if they are no longer needed for future use.
Install & Uninstall Logs
======================================================================
All Halcyon PrimeAlert install and uninstall log files can be found
in the following directories:
/var/opt/SUNWsymon/install
/var/opt/SUNWsymon/uninstall/log
Installation Log
----------------
The name of the installation log for this product is the following:
HALEnterpriseReporter-install_[YYYYMMDD]-[HHMMSS].log
Uninstall Log
-------------
The following is the generic uninstall log file:
uninstall.log.[YYYYMMDD]-[HHMMSS]
---//---