/
Install ServiceManager Deploying ServiceManager Server Manual Installation
Document toolboxDocument toolbox

Install ServiceManager Deploying ServiceManager Server Manual Installation

Owned by Paul Hindle
Last updated: Oct 30, 2019 by Andrew Hill (Deactivated)Version comment

On This Page:

As described in Install ServiceManager Before you Start the ServiceManager release includes a ZIP file archive containing a complete image of the ServiceManager application environment.  Whilst the software will require a degree of manual configuration the basic installation is straightforward - simply extract the contents to some predetermined location.

Once extracted, the ServiceManager application set needs configuring in order for it to operate correctly (see Install ServiceManager Deploying ServiceManager Server Configuration Parameter Requirements).  The following information is required:

  • SOAP connectivity information (end point and user)
  • Database connectivity information (URL, user and password)
  • Application Name

This information must be manually entered into the appropriate configuration file as described below.

SOAP Connectivity

ServiceManager communicates with ServiceOptimizer via the server's SOAP API implementation.  To instantiate this connection point ServiceManager needs both an endpoint and SOAP database user to be defined.  Note that the end point must also include the port number.  This information should be specified within the service_manager.properties file located within the sm_properties directory of the installation.

service_manager.properties 
###########################################################################
# Name: service_manager.properties
# Desc: This is an example of the main SERVICEManager properties file.
#
#      The location of this properties file is dependent upon the system 
#      property: "com.servicepower.servicemanager.propertiesFile" which 
#      should be the location of the file in question.
###########################################################################
# properties for SOAP interaction.  In order for SERVICEManager to interact 
# with the SERVICEOptimizer SOAP server the following information *must* be 
# correct.
#
# soap.server.url       - the protocol://server:port_no
# soap.login.dbusername - the schema name used by SERVICEOptimizer to start
#                         
soap.server.url=http://spdev:18081 
soap.login.dbuser=svmuser

Database Connectivity

ServiceManager retrieves most of the information it requires from the ServiceScheduling’s database, to do this the appropriate database connectivity method needs to be defined.  Specifically the database type, connection URL, trusted user and password information.

This information must reside within the hibernate.cfg.xml file located within the sm_properties directory of the ServiceManager installation.

The installed version of this file contains two commented out XML definitions for the database connection - one for Oracle and one for SQL Server.  Copy, and remove the comments of, the appropriate XML definition and specify the connection URL and username/password combination.

 

ServiceManager utilises the Hibernate Object Relational Mapping framework to retrieve data from and persist data to the ServiceScheduling database schema. A full specification of Hibernate can be obtained at from the Hibernate Organisation website http://hibernate.org/, but details of configuring Hibernate to employ a connection pooling strategy are described here.

In addition to the connection entries described above, administrators should ensure that a suitable pooling configuration is setup in order to achieve optimum performance and scalability. By default ServiceManager is supplied with a generalised connection pool setup. This is achieved by adding the following entries to hibernate.cfg.xml within the <session-factory> section.

When Tomcat is started this will result in an initial number ( hibernate.c3p0.min_size ) of connections being made to the ServiceScheduling database. Additional connections will be added to the pool up to the hibernate.c3p0.max_size setting when this pool is exhausted. For further details on how to modify these settings for your specific requirements refer to the C3P0 section in the Hibernate Organisation website.

Session Factory 
<session-factory>
    <property name="connection.url">
        jdbc:oracle:thin:@localhost:1521:sbs_112
    </property>
    <property name="connection.username">sbs</property>
    <property name="connection.password">sbs</property>
    <property name="connection.driver_class">
        oracle.jdbc.driver.OracleDriver
    </property>
    <property name="dialect">org.hibernate.dialect.OracleDialect</property>
</session-factory>
Connection Pool management 
<property name="hibernate.connection.provider_class">
org.hibernate.connection.C3P0ConnectionProvider
</property>
<property name="hibernate.c3p0.min_size">
      1
</property>
<property name="hibernate.c3p0.max_size">
100
</property>
<property name="hibernate.c3p0.timeout">
1800
</property>
<property name="hibernate.c3p0.max_statements">
50
</property>  

Application Name

If the ServiceManager application requires renaming then the web application archive ( SERVICEManager.war ) located within the SVM_HOME/tomcat/webapps directory should be renamed appropriately prior to starting the application server. 

Within the Java application server environment it is the name of the application archive (WAR file) that determines the name of the web application.  This is case sensitive (this is also true on Windows platforms) and the name is reflected in the URL specified by the client browser. 

For example if the WAR file were renamed svm-demo.war then the URL would include the application name svm-demo similar to: http://spower:8080/svm-demo.  However if the WAR file was renamed to SVM-demo then the connection URL would be similar to: http://spower:8080/SVM-demo.

Note that the WAR file should be renamed and not copied.  Java application servers check their respective webapps directory for WAR files.  Any such file is assumed to be the archive for a web application, copying the file would result in the application server instance hosting in effect two ServiceManager application instances each with a unique URL.

Modules Directory

If ServiceManager modules are to be installed then a modules directory needs to be defined (Install ServiceManager Deploying ServiceManager Server Configuration Parameter Requirements). 

This directory may be anywhere on the disk, however, placing it outside of ServiceManager’s installation directory allows for ServiceManager to be re-installed without having to re-install all of its modules.
# modules.dir - the directory under which the installation directory
#     for SERVICEManager modules are to be placed.
modules.dir=c:/Program Files/SERVICEManager/sm_properties/modules