Guide to setting up MetricStream

Application on Windows platform

USER GUIDE DOCUMENT

VERSION 6.1.3.2.0
JANUARY’2015
 MetricStream-Installer-Setup-Guide-Windows

Copyright Notices
Copyright © 2015 MetricStream Inc., All Rights Reserved.

This document as well as the software described within it, is furnished under license and may only be
used or copied within the terms of that license. The information in this document is provided for
informational purposes only, is subject to change without notice, and should not be construed as a
commitment by MetricStream, Inc. MetricStream, Inc. assumes no responsibility or liability for any errors
or inaccuracies that may appear in this document.

Except as permitted by license, no part of this publication may be reproduced, stored in a retrieval
system, or transmitted, in any form or by any means – electronic, mechanical, recording, or otherwise –
without the prior written permission of MetricStream, Inc.

Written and designed at MetricStream, Inc., 2600, East Bayshore Rd., Palo Alto, CA, 94065, U.S.A.

Printed in the U.S.A.

CAUTION

This document contains proprietary, confidential information that is the exclusive property of
MetricStream, Inc. If you do not have a valid contract with MetricStream for the use of this document, or
have not signed a non-disclosure agreement with MetricStream, then you received this document in an
unauthorized manner and are not legally entitled to possess or read it.

Use, duplication, and disclosure are subject to restrictions stated in your contract with MetricStream, Inc.
Use, duplication, and disclosure by the Government are subject to restrictions for commercial software
and shall be deemed to be Restricted Rights software under Federal Law.

2 Copyright © 2016 MetricStream Inc.

Reference Documents
Document Description
MS_WebSphere_EGRCP6x_ Help guide to configure WebSphere application server.
ConfigurationGuide.pdf

MS_JBOSS_EGRCP6x_Confi Help guide to configure JBoss application server.

gurationGuide.pdf
MS_WebLogic_EGRCP_Conf Help guide to configure Weblogic application server.
igurationGuide.pdf

3
Feedback
MetricStream welcomes customers' comments and suggestions on the quality and usefulness of this document.
Your feedback is important, and helps us to best meet your needs as a user of our products. For example:
 Did you understand the context of the procedures?
 Did you find any errors in the information?
 Does the structure of the information help you to complete your tasks?
 Do you need different information or graphics? If so, where, and in what format?
 Are the examples correct? Do you need more examples?

If you find any errors or have any other suggestions for improvement, then please tell us.
Send your comments to us using the electronic mail address: [email protected]
Please give your name, address, electronic mail address, and telephone number (optional).
If you need assistance with MetricStream software, then please contact MetricStream Support Services at
[email protected] reach us at 800-858-5658.

If you require training or instruction in using MetricStream software, then please contact MetricStream office.
A list of MetricStream offices is available on our Web site at http://www.metricstream.com/

4
Table of Contents
Chapter 1. Introduction.......................................................... 6
Purpose ..........................................................................................................6
Audience ........................................................................................................6
Chapter 2. Getting Started .................................................... 7
System Requirements ...................................................................................7
Database Installation.....................................................................................7
AppServer Installation ..................................................................................7
Windows login user profile ...........................................................................7
MetricStream Application License Key ........................................................7
MetricStream Module Installer Files .............................................................8
MetricStream Installer File ............................................................................8
Assumptions .................................................................................................8
Chapter 3. Installing MetricStream Application using MetricStream
Installer 9
In case MetricStream Installer (MSUI) older than 6.1.1.x is installed .........9
In case MetricStream Installer (MSUI) 6.1.1.x is installed ...........................9
Installing the MetricStream Installer ............................................................9
Work with the MetricStream Installer GUI ..................................................14
Upgrade MetricStream Application in GUI mode. .....................................31
Working with the MetricStream Installer Command Line Mode ...............32
Chapter 4. Running the Installed Application ....................... 37
Upgrading an existing application stack in Command Line Mode ..........37
Upgrade or re-install Apache and Tomcat in Command Line Mode ........37
Appendix I – Abbreviations/Terminologies .............................. 38
Appendix II – Parameters used by MetricStream Installer ....... 39
Appendix III – System Requirements for RI Application .......... 43
Appendix IV – Application License Key Generation ................ 44

5
 MetricStream-Installer-Setup-Guide-Windows

Chapter 1. Introduction
Purpose
This document serves as a guideline to set up a fresh instance of a MetricStream application on a server that is
running on Windows OS. It describes how to pre-configure a server for MetricStream application and how to run
the MetricStream Installer.

Audience
This document is intended for system administrators or individuals who require to install and configure the
MetricStream Application. The person must have basic knowledge of Windows Operating System and should be
familiar with the configuration parameters of Oracle database.

6 Copyright © 2016 MetricStream Inc.

Chapter 2. Getting Started
System Requirements
The system requirements of MetricStream application must be verified with the recommendations provided by the
Metric Stream configuration team. Note that database can be hosted either in the same or in a different server
as the application. The system requirement can be impacted by the number of different modules as well as the
number of concurrent active users. Appendix III provides an example of a required system configuration for a
typical reference implementation (RI) application.

Database Installation
Oracle database is required for MetricStream application. It is mandatory to install Oracle Database in the server
which can connect to the application.
The required Oracle configuration can be setup through the process of the installing MetricStream application.

AppServer Installation

The MetricStream Installer currently comes bundled with the Apache Tomcat Server. Hence, there are no separate
Tomcat specific steps to be performed.

However, if the AppServer is any of the following, then we recommend you to install Apache Tomcat Server from
your concern IT Support team and follow the instructions mentioned in the respective configuration guides
provided by MetricStream.

Each configuration guide provides information on how to configure the AppServer and the deployment process of
MetricStream Application, along with the steps to trouble shoot in case of errors..

Websphere: MS_WebSphere_EGRCP6x_ConfigurationGuide.pdf
Jboss : MS_JBOSS_EGRCP6x_ConfigurationGuide.pdf
WebLogic: MS_WebLogic_EGRCP_ConfigurationGuide.pdf

Windows login user profile

The MetricStream Installer can be installed by logging in as any of the registered users on the host application
server.

MetricStream Application License Key

A license key is required to activate the installed application.The MetricStream license key is encapsulated into two
different files and can be generated by a Web License Key Generator. It is assumed that user has already obtained
the license key files before starting the installation process. Appendix III provides a detail on how a license key
can be obtained using the Generator.

7
MetricStream Module Installer Files
Before installing the MetricStream application, all required installer files of the product modules (including
platform, AppStudio, GRCF) must be available on the server that the installation is being performed. It is assumed
that user has copied the installer files to a temporary storage on the server before the MetricStream installation
process is started.

MetricStream Installer File

Similar to the module installer files, MetricStream Installer file must also be available on the server that the
installation is being performed. Note that MetricStream Installer for 32bit server is different from 64bits. A
correct version of MetricStream Installer needs to be used to start the MetricStream installation process. You
require a correct version of MetricStream Installer, before the installation of MetricStream Application.

Assumptions
A successful instance set up is subjected to several key assumptions for the database server as well as the
application servers. The following are the complete list of assumptions. These assumptions can be used as a
checklist for the MetricStream Installation process.

1. Database server:
a. Oracle database release is 11.2.0.3 or above and 12c
b. Oracle Database Service has already been created and is up and running.
c. Database listener service and tnsnames is configured and is running.
d. Database administrator has either created the schema user or oracle system user authentication is
available for configuration.
2. Application server:
a. Oracle Client is installed and configured (Only in case the database server is on different hardware)
b. The application license keys are available in a temporary storage location.
c. The required ECP, Appstudio, GRCF, and other modules installers are available at any temporary
storage location.
d. The recommended MetricStream Installer version (Windows version) with correct system type (32bits
or 64bits) is available at a temporary storage location.
e. Any file transfer tool to download and transfer installers between the systems is available.
f. This document provides installation information for using Apache and Tomcat (which comes
packaged with the MetricStream Installer). If the user wants to install other AppServer (i.e.
WebLogic, WebSphere, or JBOSS), it is assumed that user will have to the AppServer already installed
in the server. It is also assumed that user is familiar with the AppServer configuration guideline
document that is listed above “AppServer Installation” section. The AppServer needs to be
configured accordingly before the MetricStream Application is installed.
g. Apps are not configured with HTTPS.

8
Chapter 3. Installing MetricStream Application using
MetricStream Installer
This chapter provides the details steps for installing a MetricStream Application. Before starting the installation
process, the assumptions listed in Chapter 2 must be verified.

In case MetricStream Installer (MSUI) older than 6.1.1.x is installed

In case you have already installed a version of MetricStream Installer/MSUI, then the following steps are
recommended to be performed before proceeding ahead:

Move the following directories under the MetricStream Home directory to a different location -
MS_Universal_Installer, MS_Logs, MS_Installers, AppsInstallerFiles

These directories will not be used by the MetricStream Installer and need to be taken out to avoid any confusion.
However, since the Administrator installing the MetricStream Installer would prefer to use the same parameter
values – as mentioned in the previous version – it is recommended to move these directories to a temporary
location in order to keep them for reference use.

In case MetricStream Installer (MSUI) 6.1.1.x is installed

User need not perform any manual steps. Please leave the MSUI related directories untouched.
The MetricStream Installer automatically updates the parameter properties value with the ones used by the earlier
installed MSUI on the instance.

Installing the MetricStream Installer

Copy the MetricStream Installer executable (MetricStreamInstaller-6-1-2-2-1-x64-Windows.exe) from the

temporary storage location to a location on the application server which has sufficient free space on its drive.

The Installer file name has the notation to indicate the release version, the system type.
The “MetricStream Home” is the directory where the MetricStream Application is installed.

Right click on the MetricStreamInstaller-6-1-2-2-1-0-x64-Windows.exe and select the Run as Administrator option.

Run as Administrator

Based on the security settings on the machine, you might be prompted to confirm if you want to allow the
executable to be installed. Click Yes.

9
The installation of MetricStream Installer will get initiated.

Setup – MetricStream Installer

Click Next. The next step will ask the user to provide the path where MetricStream installer will be installed. Do
note that this location will now be referred as the MetricStream Home throughout this document. Choose a path
with sufficient disk space.

10
Select Destination Location1

The next step will ask for the confirmation to Install the MetricStream Installer in the destination path.

Ready to Install2

A successful installation will end with the following way:

11
Finish3

Once the installation is successful, the following files and directories will be created in the MetricStream Home
which was passed as an argument while installing MetricStream installer

12
Folder Structure

Note – ms-logs folder is created while installing Apps/modules, ms-installer.bat file is displayed if install
MetricStream Installer on Windows OS and ms-installer.sh file is displayed if install MetricStream Installer on Linux
OS
Move the module installer files that were placed in the temporary directory (as mentioned in 2(c) of Assumptions)
to ms-packages directory under <MetricStream Home>/ metricstream-installer-app

You can view the other available options, by executing the below command:

ms-installer.bat –help

13
Help Commands4

Work with the MetricStream Installer GUI

NOTE: GUI mode installs only those installers that have .msar extension. For installers with .jar extension, please
use the command line mode.

From the Windows Start Menu, find the Command Prompt icon and right click on it. Select the Run as
Administrator option.

Rund as Administrator

Run the following command to navigate to the <MetricStream Home > /metricstream-installer-app.

cd /d <MetricStream Home > \metricstream-installer-app

Launch the MetricStream Installer GUI using the following command

ms-installer.bat -i

Opening GUI5

A MetricStream Installer GUI will pop up. The GUI provides a powerful and simple interface for user to install the
MetricStream applications. Below is the GUI showing the Home Page of the MetricStream Installer.

14
 Welcome Window

Note – Configure Database, Configure Platform, Install and Configure Apache and Tomcat, Pre-requisite check
icons are disabled at the first time. Once each of the operations is completed, for the subsequent visits to the
home page, these options will be enabled.

From the GUI home page, user can start the following process flow to install a MetricStream application:

1. Click the “Install/Upgrade Product Modules/Solutions” icon to start the flow. The Database
Configuration page (see below) will be display.

15
 Database Configuration

The MetricStream Installer verifies the database connection and the schema details the moment the user enters
the field values.

Database Configuration

16
 2. User can enter the database configuration information if the default data values need to be over-written.

If more advance information is needed, user can select the “Advanced tag” to view/modify the
information as shown in the page below. Default values are also populated for fields in the advanced tab.

The description of every parameter is available in Appendix II.

Database Configuration

Once the data are entered and confirmed, click the Configure button – the configuration in Progress
screen will be displayed.

MetricStream Installer by default configures the system for JNDI connection. ECP versions starting with
6.1SP6 supports JNDI mode, hence if you are on older versions, then please change the “Select Mode”
dropdown value to JDBC connection.

17
 Databse Configuration

“Operation Completed Successfully” message displayed once configuration completed.

Databse configuration completed

Click the OK button – “Web Server Configuration” page will be displayed.

18
 3. Before proceeding to the other configuration sections, the user can run a pre-requisite check. This section
is enabled only after the database configuration is completed.

Click on the Top bar displaying MetricStream Installer to go back to the landing page of MetricStream
Installer. Click on the Pre-requisite Check block .You will have to enter the password for the Schema that
you just configured from the Database Configuration block.

Pre-requisite Check

Click on Submit. The MetricStream Installer will publish an HTML report on the screen that will provide
the result of the check it did on certain key system parameters of the application and database. The
report is in a table format comparing Expected Values and the Returned Values (in color), where Green
would indicate a pass and Red would imply that the returned value of the does not meet the expected
value for that system parameter.

19
Pre-requisite Check Report

Click the OK button to go back to the landing page.

Note – Pre-requisite Check is done automatically by MetricStream Installer before installing

Apps/Modules.
Installation is terminated if Pre-requisite check is failed (if mandatory parameters (* marked parameters
are mandatory) are not matched)
Check Pre-requisite check html report which is created under ms-log folder in case of failure

4. User can enter the Web Server configuration information if the default data values need to be over-
written.

If user does not need to change any Web Server configuration information, user can click the “Skip”
button. The “Apache Tomcat Configuration” page will be displayed (as shown in Step 4).

20
 Web Server Configuration

If more advance information is needed, user can select the “Advanced tag” to view/modify the
information as shown in the page below. Default values are also populated for fields in the Advanced tab.

The description of every parameter is available in Appendix II.

Web Server Configuration

21
 Once the data are entered and confirmed, click the Configure button – the Configuration in Progress
screen displays.

Configuration

“Operation Completed Successfully” message displayed once configuration completed.

Click the OK button – the “Apache Tomcat Configuration” page will be displayed.

5. User can enter the Apache Tomcat Configuration information if the default data values need to be over-
written.

If user does not need to change any Apache Tomcat configuration information, user can click the “Skip”
button. The “GRC Platform Configuration” page will be displayed (as shown in Step 5).

22
 Tomcat Configuration

If more advance information is needed, user can select the “Advanced tab” to view/modify the
information as shown in the page below. Default values are also populated for fields in Advanced tab.

The description of every parameter is available in Appendix II.

23
 Tomcat Configuration

Once the data are entered and confirmed, click the Configure button – the Configuration in Progress
screen displays

Tomcat Configuration Progress

“Operation Completed Successfully” message displayed once configuration completed.

Click the OK button – the “GRC Platform Configuration” page will be displayed.

24
 6. User can enter the GRC Platform Configuration information if the default data values need to be over-
written.

Platform Configuration

The first time user can enter all the values and choose configure option. The values will be used by
MetricStream Installer while installing and configuring Platform. On subsequent visits, if user does not
need to change any GRC Platform configuration information; user can click the “Skip” button. The “Install
MetricStream Application” page will be displayed (as shown in Step 6).

If more advance information is needed, user can select the “Advanced tag” to view/modify the
information as shown in the page below. Default values are also populated for fields in Advanced tab.

The description of every parameter is available in Appendix II.

25
 Platform Configuration

Once the data are entered and confirmed, click the Configure button – Configuration in Progress screen
will be displayed.

“Operation Completed Successfully” message displayed once configuration completed.

Click the OK button – the “Install MetricStream Application” page will be displayed

7. User needs to select the installation file for the MetricStream Application. The file consists of the
platform, AppStudio, GRCF and all modules that are bundled for the application.

26
Install MetricStream Application

Note – user can add one or more installers from the folders other than ms-packages folder using “Browse
Installer” Button.
The GUI supports installation of files of type “msar”.
Click the Install button – the Installation of the modules will be started.

Installation inprogress

27
 “Operation Completed Successfully” message displayed once Installation completed.
Click the OK button – MetricStream Installer Home page will be displayed.

Note – Provide “System” password while installing DMS modules to provide required grants for DB user

Database error handling while installing/upgrading ECP

Error handling mechanism is implemented to capture sql errors while running ECP db scripts from ECP 6.1.6.4.0.0
When PROD_MODE=y and DB installation fails then Installation will stop. (This is the default option during
installation, even if the variable is not explicitly set)

ECP Database Errors

When PROD_MODE=n - This option displayed message for user to stop or continue ECP installation if ECP DB
scripts execution has errors. (for internal use only)

28
ECP DB errors

Note – This feature is implemented from ECPSP6 Patch4 onwards

IUP Error handling through MetricStream Installer

MI can stop/terminate the installation if IUP scripts execution has errors.

Module/Apps Installation will be terminated/Stop by MI when IUP import has errors when Prod_mode=y (This is
the default option during installation, even if the variable is not explicitly set ). In this mode the installation exists
as soon as it finds the first error during installation.)

29
Iup Errors

-MI:PROD_MODE= n ( Production mode set to No - for internal use only, has to be explicitly set while running MI)
This option is provided so that QA / RI testing will not be delayed due to ignorable errors.

Command to install Apps/modules with PROD_MODE=n

Ms-installer.bat –i –MI:PROD_MODE=n

30
IUP errors

Upgrade MetricStream Application in GUI mode.

1. Copy the installers to <MetricStream Home/metricstream-installer-app/ms-packages folder.

2. Launch MetricStream Installer GUI from the command line using the following command from the
command line
cd < MetricStream Home>/ metricstream-installer-app
./ms-installer.sh –i
The MetricStream Installer GUI will pop up.

31
Welcome to MetricStream Installer window
1. Click the “Install/Upgrade Product Modules/Solutions” to go to the Database configuration scree.
2. Enter the Schema password and Confirm Schema Password and click “Next”
3. Use “Skip” option on “Web Server Configuration”, “Apache Tomcat Configuration” and “GRC Platform
configuration”.
4. Select the installer and click “Install” to install the module.

Refactoring MI log folder structure

Archive folder under ms-log folder - previous/old installation log folders to be moved to Archive folder and only
displayed latest log folder under ms-log folder

MetricStream Installer will not install and terminate the install as shown in below screen shot if any files are in use
from current log folder

Warning message if current log files are in use

Working with the MetricStream Installer Command Line Mode

NOTE: The command line mode supports installers with .msar as well as .jar extension

32
The GUI mode of MetricStream Installer is not supported on some versions of Linux OS. In that case, the command
line mode can be used.

3. Navigate to the metricstream-installer-app directory using the following command:

cd < MetricStream Home>/ metricstream-installer-app

Edit the ms-installer-parameters.properties using any text editor. This file contains all the parameters that are
required by MetricStream Installer for installing and configuring the application. The parameters are the same
as in the GUI mode.

Refer the Appendix II for details on each parameter and fill the value for each parameter accordingly.

4. Once the database schema user is configured, the user can run the pre-requisite check. The MetricStream
Installer will publish an HTML report on the screen that will provide the result of the check it did on certain key
system parameters of the application and database.

To perform the health check, run the ms-installer.bat with –health option.

Help commands

Press ENTTER if the ms-installer-parameters.properties is in its default location.

You will next be prompted to enter the Schema password.

Provide the password and hit ENTER.
The MetricStream Installer will perform the health check and provide a report titled PreRequisiteCheck-YYYY-
MM-DD-HH-Min-Sec.html under <MetricStream Home>\metricstream-installer-app\ms-
logs\MetricStreamYYYY-MM-DD-HH-Min-Sec \logDir. The report will be in the below described format:

Pre-requisite report

The report is in a tabular format comparing Expected Values and the Returned Values (in color), where Green
would indicate a pass and Red would imply that the returned value of the does not meet the expected value
for that system parameter.

33
5. Assuming that the module installers are already available in the MS_Installers directory, we can now proceed
for installation.

Enter the names of the modules installers in the < MetricStream Home>/ metricstream-installer-app/ms-
packages/ installer-list.txt in the order of their installation.

The order list provided in the installer-list.txt file is automatically read by MetricStream Installer to know
which modules have to be installed and in what order.

Below illustration shows Platform and Appstudio installer names mentioned in order. MetricStream Installer in
this will case install Platform first followed by Appstudio.

Execute the below command along with the arguments expected from < MetricStream Home>/ metricstream-
installer-app directory.

ms-installer.bat -p <Schema Password> -s <Oracle System Password>

Where,
<Schema Password>: Password of the database schema of your MetricStream application
<Oracle System Password>: Password of the Oracle SYSTEM user

You will be asked to enter the path to the ms-installer-parameters.properties as shown below. Press ENTER
key to use the ms-installer-parameters.properties from its default location < MetricStream Home>/
metricstream-installer-app.

Command line installation

The installation will commence on hitting ENTER key. A couple of confirmation messages will be prompted
which the user will have to answer in Y or N.

34
Command line installation

Post confirmation, the installation will commence and the progress can be seen on the console. Do not cancel
or close the terminal as this will terminate the installation.

Note – Provide “System” password while installing DMS modules to provide required grants for DB user

SSL Configuration through command line mode

To Configure SSL run the below command from installdir/metricstream-installer/ as administrator (refer the below
screen shot)

Windows – ms-installer.bar –ssl

SSL Configuration

Note – SSL Configuration through GUI not supported

Generating Demo certification for SSL

Run the below steps to Generate Demo Certificate for SSL (refer the below screen shot)

./ms-installer.bat –genDemoCrt -[your-machine Details] – [your-country] – [your-state] –[your-province]

35
Generating Demo Certificate

Note – imported certificate should be copied manually into directory

36
Chapter 4. Running the Installed Application
Once the application is installed, user needs to make sure the license key files are saved in the
<MetricStream Home>/SYSTEMi/Systemi/keys folder.

User can then restart the Apache and Tomcat Services from the Windows Services Console. The Apache and
Tomcat services would have been registered as the Service Names that were provided during in their respective
Configuration sections (in GUI mode) or as specified in the ms-installer-parameters.properties (in case of command
line mode)

URL to access the application is shown. As HTTPS is not supported please access the application in browser using
HTTP. http://<webserver hostname>:<web server port number> .The login page of the installed application will be
displayed .

Upgrading an existing application stack in Command Line Mode

To upgrade new modules or add additional products to the existing stack,
 copy the installer files to < MetricStream Home>/ metricstream-installer-app/ms-packages
folder,
 update the installer-list.txt(under < MetricStream Home>/ metricstream-installer-app/ms-
packages) with the list of modules to be installed
 run the command ms-installer.bat -p <Schema Password>
You will be asked to enter the path to the ms-installer-parameters.properties. Press ENTER key to use the ms-
installer-parameters.properties from its default location < MetricStream Home>/ metricstream-installer-app.
The MetricStream Installer will install the modules listed in the installer-list.txt.

Upgrade or re-install Apache and Tomcat in Command Line Mode

To upgrade/re-install Apache and/or Tomcat, make sure that the installers are available in ms-packages
folder(MetricStream installer packages Apache and Tomcat by default ), add the installer name in the installer-
list.txt and run MetricStream Installer using the command ms-installer.bat -p <Schema Password>

37
Appendix I – Abbreviations/Terminologies

Term/Abbreviation Meaning
RI Reference Implementation
Stack Ordered list of modules to be installed for the
instance
HDD Hard Drive Disk
Application server Environment on which MetricStream instance will
be installed and deployed on a server like
Tomcat/JBoss/WebSphere.
Database server Environment on which the Oracle database is
installed.
Instance Refers to the MetricStream application
MetricStream Installer (earlier known as MSUI) MetricStream Installer is a tool to deploy and
configure MetricStream Application
JNDI Java Naming and Directory Interface

38
Appendix II – Parameters used by MetricStream
Installer

The below tables acts as a reference to understand the parameters used to configure MetricStream Installer. The
same sets of parameters appear in both the GUI and command line mode.

Parameter name ( Parameter as it Description Default Value

as it appears in the appears in the
ms-installer- GUI mode
parameters.properti
es) in command line
mode
Database Configuration
DatabaseHostName host Machine name of the server on which database is localhost
installed
DbPort Port Port number on which Oracle database listens for 1521
connections
Sid SID Oracle System ID of the database -

NOTE: Read ServiceDbUrl Parameter description

also.
SchemaName Schema User Name of the database schema for your -
Name MetricStream Application
- Oracle System Password of the Oracle SYSTEM user. -
Password To be passed as an argument in case of command
line mode
- Schema Password of the database schema for your -
Password MetricStream Application
To be passed as an argument in case of command
line mode
Database Configuration using JDBC ( i.e. of Mode is selected as JDBC in Advanced section of GUI)
Oracle_Client - MetricStream Installer uses Oracle JDBC Thin driver thin
as a Client to connect to the database
TableSpace_Data Data Table space Name of the tablespace for storing database -
Name objects
TableSpace_IDX Index Table Name of tablespace for storing indexes -
space Name
TableSpace_Idx_Loc Index Table Directory path to the location where data files -
ation space Location related to the Index Tablespace will be stored.

NOTE: Values of paths provided in ms-installer-

parameters.properties should have “double back
slash “ as the path separator.
TableSpace_Data_Lo Data Table space Directory path to the location where data files -
cation Location related to the Data Tablespace will be stored

NOTE: Values of paths provided in ms-installer-

parameters.properties should have “double back

39
 slash “ as the path separator.
TableSpace_Temp Temp Table Temporary tablespace for the Schema of your TEMP
space Name MetricStream application.
Locale Default Locale Type of locale to be used by your MetricStream en_US
Application. This will decide the country specific
format of date, time and other standard notations.
JdbcExecutionFlag - The Flag that indicates whether MetricStream No
Installer will use SQLPlus to connect to database.
If Yes, SQLPlus is not required.
If No, SQLPlus is required.

Note: This option is yet to be supported from ECP

and hence it is advised not to change the default
value.
DataBaseDriverNam Database Driver MetricStream Installer uses the Oracle JDBC driver oracle.jdbc.Oracl
e to connect to the database eDriver
ServiceDbUrl - If you are passing service name of the database null
instead of its Oracle SID in the Sid parameter , then
the value of this parameter will have to be
provided in the below mentioned format:

jdbc:oracle:thin:@localhost:1521/<<SERVICENAME
>>

Not supported in GUI mode currently

EncryptionType - The encryption type that you wish to use for SYSTEMI
encrypting the password of your database schema.

Default value – SYSTEMI – will use the

MetricStream standard encryption algorithm

Not supported in GUI mode currently

PublicKeyPath - If Encryption Type is other than default value, -
provide the directory path to the public key file

Leave blank if Encryption Type is SYSTEMI

Not supported in GUI mode currently

PrivateKeyPath - If Encryption Type is other than default value, -
provide the directory path to the private key file

Leave blank if Encryption Type is SYSTEMI

Not supported in GUI mode currently

Database Configuration using JNDI ( i.e. of Mode is selected as JNDI in Advanced section of GUI)
NOTE: This feature will be functional only in future releases of ECP as and when notified.
JNDIExecutionFlag Mode is selected The flag that determines if Platform should be Yes
as JNDI configured for JDBC or JNDI connection.
configuration
If set to Yes, Platform will be configured to use
JNDI
If set to No, Platform will be configured to use JDBC

40
DataSourceName Data Source The name of the connection that will be set up to jdbc/oracle/msi
Name your database. This name will be used when
creating a query to the database.
DataAccess Database Driver Driver used by JNDI. Do not change the default com.metricstrea
value. m.dataaccess.ora
cle.ver9205.drive
r.DSDriver
CustomConnPool Custom JNDI connection pool setting. Do not change the com.metricstrea
Connection Pool default value. m.systemi.server
.dspool.Connecti
onPoolImpl(ignor
e_credentials=ye
s)
dataSourcePrfx Datasource java:comp/env/
Prefix
Database Configuration using RAC (If OracleConnectionString is populated, it is mandatory to populate
jdbcUrlString because DatabaseHostName,DbPort and Sid will not be read from above in such case).
OracleConnectionStr - Which will be the RAC URL [for eg. Instead of null
ing sid=orcl he will provide the whole tns entry or RAC
url connection string] ex -
OracleConnectionString=localhost:1521/orcl.metric
stream.com=null
jdbcUrlString - which will be the jdbc string for connection (Ex- null
jdbcUrlString=jdbc:oracle:thin:@//localhost:1521/
orcl.metricstream.com)
Web Server Configuration
WebServer_HostNa Web Server Host Machine name of the application server. -
me Name
Webserver_Port Web Server Port Port number on which the MetricStream -
Number application will be accessed.
ApacheServiceName Web Server Name for the Web server windows service ApacheService
Service Name
Apache Tomcat Configuration
HostName Tomcat Host Machine name of the application server. -
Name
AjpPort Tomcat The port at which Tomcat will communicate with 8269
Connector Port the web server ( Apache in our case) using the
(AJP) Apache JServ Protocol (AJP)

HttpPort Tomcat The TCP port number on which Tomcat will listen 8270
Connector Port for requests and pass on to the web server (Apache
(HTTP) in our case).

CtrlPort Tomcat Control The TCP/IP port number on which Tomcat waits for 8271
Port a shutdown command.

TomcatServiceName Tomcat Service Name for the Tomcat server windows service TomcatService
Name
GRC Platform Configuration
- Web Server Machine name of the application server. -

41
 Domain Name
Admin_Email Web Server Email address of the person who will administer -
Admin Mail the MetricStream application. All notifications from
the application will be sent at this address.
Enterprise Name Enterprise Name Enterprise name that you wish to have for your MetricStream
Metricstream Application
Secure_Option Use Secure If set to “Yes”, then HTTPS protocol is used to No
Installation access the MetricStream application.

NOTE: The HTTPS access feature will be available

only in future releases of ECP as and when notified.

Hence, the current value should remain as No.

WorkFlow_HostNam Workflow Do not change this value. localhost
e Hostname
Sql_AgentPort Agent Port Port at which SQL channel component listens -
Number(SQL
Infolet)
NonSql_AgentPort Agent Port Port at which NON SQL channel component listens -
Number(Non
SQL Infolet)
Java_Min_HeapSize Min Heap Size Minimum heap size of the JVM used by the 1024m
MetricStream application
Java_Max_HeapSize Max Heap Size Maximum heap size of the JVM used by the 2048m
MetricStream application
WebService_Port Web Service Port used by Platform for web service -
Port Number

42
Appendix III – System Requirements for RI Application

The system configuration details provided below are required for a typical RI stack setup. While the application
server is installed in Linux, the Oracle database server, if it is installed in a separated server, is supported on
Windows, Solaris or Linux OS.

Application Server Database Server

Operating System Type Linux Linux/windows/solaris
HDD size 40GB 40GB

80GB if database hosted on the Not applicable, if database hosted

same on the application server.

RAM size 4GB 4GB

8GB if database hosted on the same Not applicable, if database hosted

server on the application server.
Operating System version 64 bit Redhat release 6.0 or higher All 64 bit
(Recommended) version
Linux - Redhat release 6.0 (or
higher)
Windows-Windows 7 (or higher),
Server 2008 (or higher)
Solaris- Sun Solaris Spark 5.10

Oracle Oracle Client 11.2.0.3 (or higher) 64- Oracle Database 11.2.0.3 (or higher)
bit, Standard edition. 64-bit, Standard edition relevant to
the Operating System.
Not required if database hosted on
the application server as Oracle
Client will be installed by default.

43
Appendix IV – Application License Key Generation
Go to http://sterling.metricstream.com:8000/newlicensekey to invoke the tool to generate the license keys for
MetricStream application. The following form will be displayed.

User is required to enter the following information:

NOTE: All fields are case sensitive.

Field Name Field description

Enterprise Name Enterprise name that you wish to have for your
Metricstream Application. This value should be the
same value as Enterprise Name parameter in the msi-
parameter.properties
Licensee Name of the licensee.

44
Max_Users Maximum number of users that can be registered with
the application
Max Concurrent Users Maximum number of users that can concurrently
remain logged in to the application.
Concurrent Users Overflow -
MAX_Metrics -
Expiration Date The date of expiry of the license
DBURL Same value as the DBURL parameter in the
<METRICSTREAM
HOME>/SYSTEMi/Systemi/Config/config.client.xml
DBUSER Same value as the DBUSER parameter in the
<METRICSTREAM
HOME>/SYSTEMi/Systemi/Config/config.client.xml
Multiple Login (Yes, no) Allow the same user to login from different sessions
Mail To: Valid email address on which the license keys will be
delivered as attachments.

On successful submission of the form, you will receive the keys on your email address. Save the files and upload
them to <MetricStream Home>\SYSTEMi\Systemi\keys folder

45