Document toolboxDocument toolbox

Before you Start 2

Owned by Matthew Wren
Jan 29, 2024
4 min read

On This Page:

Related Pages:

Check Pre-requisites

Check that the pre-requisites listed in the ServiceManager Pre-requisites and ServiceOptimizer Pre-requisites are in place. If a pre-requisite is not in place then the installation or subsequent running might fail.

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 and scripting; and
  • Enable Java add-ons for applet processing.

Enable Java and add the URL where ServiceManager will be run to the exception site list in the Java Control Panel.

  • On Windows, the javacpl.exe command to run the Java Control Panel can be found in the Java bin directory.

Unpacking

The majority of this guide focuses on the supplied software release bundle. This bundle comprises of, in compressed (ZIP) format, a ServiceManager Windows .EXE installer package.

The software bundle contains the ServiceManager web application, an application server (Apache Tomcat) and the required version of the Java Runtime Environment (JRE).

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_install.exe (the Windows .EXE installer).

Deployment Directory Structure

The following diagram represents the directory structure installed on the target machine. It is not comprehensive; only files and directories of interest are highlighted.

Note that the physical location of the "root" directory (\ServiceManager) will be dependent upon the location you choose to install ServiceManager in.

\ServiceManager [1]
	install_tomcat_service.bat [2]
 
		\java [3]
 
		\misc\sso [4]
 
		\modules [5]

		\sm_properties [6]
			hibernate.cfg.xml*
			service_manager.properties*
			service_planner.properties*
			logging.properties
			svm_instance_config.xml
 						
		\tomcat [7]
				\bin [8]
						tomcat8.exe
                        tomcat8w.exe 
				\conf [9]
						server.xml
						context.xml
				\lib
						database drivers [10]
				\logs
                \webapps
						SERVICEManager.war [11]
						\SERVICEManager [12]
				\work
 						\Catalina
                        		\localhost
                                		\SERVICEManager [13]

 

 

[1]From this point onwards this directory location will be known as SVM_HOME in this document.
[2]The install_tomcat_service.bat script installs and removes the Tomcat service. Refer to Execution Environment for further details.
[3]This is the Java Runtime Environment provided with this ServiceManager installation. See Execution Environment for further details.
[4]Copies of ntlmauth.dll for different processor architectures. These files are not installed by the installer but are available in the ServiceManager zip files. See MSSQL SSO Configuration for further details.
[5]This is the directory used to store ServiceManager modules, such as ServicePlanner 1 and ServiceAnalytics. Both of these modules are installed as part of the ServiceManager installation process.
[6]

This is the directory used to store ServiceManager configuration details. It is outside of the Application Server installation folder in order to allow complete upgrades to a given version without compromising the current ServiceManager settings.

The ServiceManager installer automatically updates asterisked files with the configuration specified during the installation. Manual installations require these files to be manually edited. See Deploying ServiceManager Server for further details.

[7]This is the Tomcat Application Server instance provided with this ServiceManager installation. This directory is commonly known as CATALINA_HOME.
[8]

tomcat8.exe is the Tomcat executable that is run when the Tomcat service is started. It can be used to run the service from the command line.

tomcat8w.exe is an admin tool for viewing and updating the Tomcat service settings that are saved in the registry.

See Execution Environment for further details.

[9]

server.xml is where Tomcat's port numbers are specified (Tomcat uses port 8080 by default). See General Issues with Tomcat Deployments for further details.

context.xml can be modified to disable the use of session cookies. See Browser Related Issues for further details.

[10]The supported Oracle and SQL Server (jTDS) drivers are deployed into Tomcat’s lib directory.
[11]ServiceManager.war is the web application archive (aka WAR file) for the ServiceManager application. When Tomcat starts it automatically deploys the WAR into a subdirectory of the same name, if it doesn't exist already.
[12]This is the expanded web archive that gets created when Tomcat detects that the SERVICEManager.war has been placed in the webapps directory.
[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.

        

         

Â