On This Page:
Related Pages:
Check Pre-requisites
With these pre-requisites in place it is important to ensure the following settings:
ALL Browsers
Whichever is the Browser of choice, the following must be configured:
Enable JavaScript
Enable scripting (from “Security Settings” within the Internet Options\Security tab).
Enable Sun Microsystems’ Java Runtime Environment (JRE) for applet processing (from “Settings” within the Internet Options\Advanced tab).
ServiceManager specifies the following font ‘preference path’ within its default Cascading Style Sheet: Verdana, Arial,Geneva, Sans-serif. The quality of the layout may be compromised if none of these fonts are available.
If Sun Microsystems' JRE is not present in the "Settings" list then it needs to be enabled from the Java Control Panel Applet within Settings\Control Panel of the client machine.
ServiceGANTT, when deployed as a Web Start application relies on a centrally installed JRE. This can be installed during the first Web Start deployment.
Unpacking
The majority of this guide focuses on the supplied software release bundle. This bundle comprises of, in compressed (ZIP) format, a disk image of the ServiceManager product suite for the appropriate operating system platform and an MSI installation (for the Windows platform). Each software bundle contains the ServiceManager web application, an application server (Tomcat or Websphere) and an appropriate Java Runtime Environment (JRE). The rest of this document is written from the perspective of using Tomcat as the application server of choice, for information on using Websphere Application Server instead, refer to the Websphere Technical Notes.
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 ServiceManager between the MSI application and manual (ZIP) extraction is the requirement for the user to update individual configuration files after the extraction. The MSI application requests this information from the user during the installation and requires no manual editing of these files.
The ServiceManager release bundle contains all the components required to install and execute the ServiceManager web application. Whilst it is possible to "mix and match" Java technologies to create a working application server environment, it is strongly recommended that customers only use the software components provided within the release bundles. In certain circumstances there may be specific reasons why certain software libraries have been included within ServiceManager, thus using some other technology may have some unexpected and difficult to diagnose effect on the deployed application.
The ServiceManager release software is located on the ServicePower installation CD-ROM within the client subdirectory: client\SERVICEManager.msi (the Windows MSI installer) and client\servicemanager (the ZIP bundles).
Deployment Directory Structure
Regardless of the installation method (MSI or ZIP file extraction) or target platform the following diagram represents the directory structure installed on the target machine.
(Note that the physical location of the "root" directory ( \ServiceManager ) will be dependent upon the location you choose to extract the files to).
\SERVICEManager [1]
svmconf.bat [2]
install_tomcat_service.bat [3]
\java [4]
\sm_properties [5]
logging.properties
service_manager.properties
service_manager_jaas.config
user_report_structure.dtd
user_report_structure.xml
svm-database-configuration file(s)
\tomcat[6]
\bin
service.bat [7]
startup.bat
shutdown.bat
\common
\lib
svm-database drivers [8]
\conf [9]
server.xml/web.xml
\logs
\server
\shared
\temp
\webapps
SERVICEManager.war [10]
\SERVICEManager [11]
...
...
\WEB-INF
web.xml [12]
\work
\Catalina
\localhost
\SERVICEManager [13]
...
...
Where:
[1] From this point onwards this directory location will be known as {SVM_HOME} in this document.
[2] svmconf is a script that should be executed prior to calling any of Tomcat's command / executable files. This script sets up a number of important environment variables that are crucial to the correct execution of Tomcat.
[3] install_tomcat_service is a convenience wrapper for managing Tomcat as a service, this is the script file that is invoked from the Windows start menu short cuts installed during the MSI. Internally install_tomcat_service runs svmconf if appropriate.
[4] This is the Java Runtime Environment provided with this ServiceManager installation and is required by Tomcat and ServiceManager. By default the application server included in the bundle will be associated with this JRE installation.
[5] This is the directory used to store ServiceManager configuration details. Within this directory reside the connectivity details for the database and SOAP [1] connections that are specific to your ServiceScheduling configuration. These are outside of the Application Server installation folder in order to allow complete upgrades to a given version without compromising the current ServiceManager settings.
These files are automatically updated during the MSI installation process. Non-MSI installations require these files to be edited appropriately.
[6] This is the Tomcat Application Server instance provided with this ServiceManager installation. This will be the latest validated version of the Tomcat Application Server supported by SBS for use with this release of ServiceManager. This directory is commonly known as CATALINA_HOME.
[7] service.bat is one of Tomcat’s command files, that provides an interface to install/uninstall Tomcat as a service for Microsoft Windows installations. It takes two parameters <install|remove> [service_name]. When invoked without a service_name parameter the service installation will be called Tomcat, in most cases this default should be used. In deployments where multiple Tomcat instances are included within the same machine each will require a different service_name (see section 4.4 for more information).
Note in general service.bat should not be called directly, rather the Tomcat service should be configured through the ServiceManager supplied install_tomcat_service.bat script as this scripts sets a number of ServiceManager specific properties required for the ServiceManager web application to run correctly.
[8] The latest supported versions of Oracle and SQL Server drivers will be automatically deployed into the application server’s common/lib subdirectory.
[9] server.xml is the central location for configuring Tomcat. It is within this file that default port numbers are specified (Tomcat uses port 8080). These defaults should be altered if there is port contention between this Tomcat installation and other applications on this machine. Refer to the Tomcat documentation in {CATALINA_HOME}/RUNNING.txt for details on how to do this.
The web.xml located here specifies aspects of behaviour common to all applications installed into this Tomcat instance and should not be modified. ServiceManager specific changes should be defined within ServiceManager’s web.xml. For details on how the web.xml file can be used to configure web application behaviour refer to the documentation on the Apache Tomcat website.
[10] ServiceManager.war is the web application archive (aka WAR file) for the ServiceManager application, this file is placed in the webapps directory of the application. When Tomcat is started this file is detected by Tomcat which will automatically unpack and deploy ServiceManager from this archive.
[11] This is the expanded web archive that gets created when Tomcat detects that the SERVICEManager.war has been placed in the webapps directory; other than the contents of the web.xml file this expanded archive will have the same content as the SERVICEManager.war file in [10].
[12] This is ServiceManager’s central web application configuration location. Configuration changes specific to ServiceManager should be made here. For example if the default session timeout for ServiceManager should be different to this timeout for the rest of the Tomcat application server then ServiceManager’s web.xml should be modified.
[13] This is Tomcat’s working directory. It will be automatically deleted and reconstructed when new versions of ServiceManager are deployed to the Tomcat instance.
[1] SOAP – Simple Object Access Protocol: One of the mechanisms by which ServiceManager communicates with ServiceOptimizer application (the other is via the ServiceOptimizer database database), requiring details of the machine ServiceOptimizer is hosted on, and the port number configured to accept SOAP traffic.