Vous êtes sur la page 1sur 115

Ipanema System

SALSA Installation Manual


(Windows, VistaFoundation 0)
7.0

Issue: February 2012

Headquarters, France
Ipanema Technologies, 28 rue de la Redoute, 92260 Fontenay-aux-Roses
email: info@ipanematech.com
tel: +33 1 55 52 15 00
Technical support
email: support@ipanematech.com
tel: +33 1 55 52 15 22
Belgium
Ipanema Technologies, Av. du Bourg. Etienne Demunter, 3 1090 Bruxelles
tel: +32 498 17 95 09
Germany
Ipanema Technologies GmbH, Gustav-Stresemann-Ring 1, 65189 Wiesbaden
tel: +49 611 97774 285
Italy
Ipanema Technologies, Via Senigallia 18/2, 20161 Milano
tel: +39 02 64672319
Singapore
Ipanema Technologies, Suntec, Centennial Tower, 3 Temasek Avenue, Singapore 039190
tel: +65 65497181
Spain
Ipanema Technologies, Plaza Pablo Ruiz Picasso 1, Torre Picasso, 28020 Madrid
tel: +34 670 450 205
Switzerland
Ipanema Technologies, Zollikerstrasse 153, CH-8008 Zurich
tel: +41 (0)43 488 45 06
The Netherlands
Ipanema Technologies, Vaartserijnstraat 16, 3523 Utrecht
tel: +31 30 890 6570
UK
Ipanema Technologies Ltd, Abbey House, Wellington Way, Weybridge, Surrey, KT13 0TT
tel: +44 1932 268 380
USA
Ipanema Technologies Corp., 200 Fifth Avenue, Waltham, MA 02451
tel: +1 781 890 8008
Technical support
email: support@ipanematech.com
tel: +1 617 862 0033
toll free number: 888 485 4884

The information contained in this document is subject to change without notice.


The information and specifications contained in this document are not contractual. The information
contained in this document is sincerely considered by Ipanema Technologies to be accurate and
reliable, but implies no warranty, either explicit or implicit. Users are responsible for their personal use
of the information and specifications. Ipanema Technologies shall not be liable for any errors which may
appear in this document.
Reproduction in any form whatsoever, without the written authorization of Ipanema Technologies, is
strictly forbidden.
Ipanema, the Ipanema logo, Ipanema System, ip|uniboss, ip|boss, ip|true, ip|fast, ip|coop,
ip|xcomp, ip|xtcp, ip|xapp, smart|path, ip|sync, ip|reporter, smart|plan, ip|export and ip|engine
are trademarks of Ipanema Technologies
Any trademarks and trade names which may be used in this document refer to the entities which own
these trademarks and these trade names, or to their products.
Ipanema Technologies renounces all proprietary interest in trademarks and trade names other than its
own.
Copyright 2001/2012, Ipanema Technologies
All rights reserved

Contents

CONTENTS
INTRODUCTION ......................................................................... ..........
1. REVISIONS ......................................................................... ..........
2. LIST OF ASSOCIATED DOCUMENTS ............................... ..........
3. DOCUMENT ORGANIZATION ........................................... ..........
4. TERMS USED ..................................................................... ..........
5. CMS IDENTIFICATION ....................................................... ..........

1
1
1
1
2
2

CHAPTER 1 IP|UNIBOSS AND IP|BOSS INSTALLATION ..... ..........


1. SALSA ARCHITECTURE .................................................... ..........
2. PREREQUISITES ............................................................... ..........
2. 1. Microsoft Visual C++ 2008 SP1 Redistributable ......... ..........
2. 2. Java Development Kit 1.6 ........................................... ..........
3. INSTALL IP|UNIBOSS, IP|BOSS AND WEB SERVERS .... ..........
3. 1. Specifications for the servers ...................................... ..........
3. 2. Install ip|uniboss, ip|boss and the web servers ........... ..........
3. 3. Connecting to SALSA ................................................. ..........
3. 4. SALSA services .......................................................... ..........
3. 5. SALSA folders ............................................................. ..........
4. INSTALL SALSA, IP|UNIBOSS AND IP|BOSS CLIENTS ... ..........
4. 1. Install SALSA, ip|uniboss and ip|boss web clients ...... ..........
4. 2. Install SALSA, ip|uniboss and ip|boss Java clients ..... ..........
4. 3. Install ip|uniboss and ip|boss CLI clients .................... ..........
5. UNINSTALL THE IPANEMA SOFTWARE APPLICATIONS ..........
5. 1. Uninstall ip|uniboss and ip|boss servers ..................... ..........
5. 2. Uninstall SALSA, ip|uniboss and ip|boss clients ......... ..........

1-1
1-1
1-3
1-4
1-7
1-11
1-11
1-11
1-20
1-22
1-24
1-25
1-25
1-25
1-34
1-36
1-36
1-37

CHAPTER 2 IP|REPORTER INSTALLATION ......................... ..........


1. IP|REPORTER ARCHITECTURE ....................................... ..........
1. 1. ip|reporter architecture with InfoVista VF0 platform .... ..........
1. 2. ip|reporter architecture with InfoVista VF4 platform .... ..........
2. PREREQUISITES ............................................................... ..........
2. 1. Java Runtime Environment 1.5 ................................... ..........
2. 2. Optimize your computer for applications ..................... ..........
3. INSTALL IP|REPORTER (VF0) ........................................... ..........
3. 1. Specifications for ip|reporter server ............................ ..........
3. 2. Multi network interfaces .............................................. ..........
3. 3. VMWare ...................................................................... ..........
3. 4. Install ip|reporter with InfoVista VF0 platform ............. ..........
3. 5. Install VistaViews ........................................................ ..........
3. 6. InfoVista services ........................................................ ..........
3. 7. Starting and Stopping InfoVista server and rich client ..........
3. 8. Obtaining License key ................................................. ..........
3. 9. Reports description ..................................................... ..........
3. 10. Backup and restore ObjectStore database (VF0) ..... ..........
4. INSTALL IP|REPORTER WEB (VF0) .................................. ..........
4. 1. Specifications for ip|reporter web server (VPSE) ........ ..........
4. 2. Install ip|reporter web .................................................. ..........
4. 3. Connecting to ip|reporter web ..................................... ..........
4. 4. VistaPortal SE 4.2 directory structure ......................... ..........
5. INSTALL IP|EXPORT SOFTWARE ..................................... ..........
5. 1. Specifications for ip|export .......................................... ..........
5. 2. ip|export process ......................................................... ..........
5. 3. Install ip|export ............................................................ ..........
5. 4. ip|export configuration ................................................. ..........
6. UNINSTALL IP|REPORTER AND IP|REPORTER WEB ..... ..........
6. 1. Uninstall VistaViews .................................................... ..........

2-1
2-1
2-1
2-2
2-3
2-3
2-4
2-5
2-5
2-5
2-6
2-6
2-18
2-23
2-24
2-25
2-26
2-29
2-30
2-30
2-31
2-46
2-48
2-50
2-50
2-50
2-51
2-55
2-62
2-62

February 2012

Ipanema Technologies

Contents

6. 2. Uninstall ip|reporter ..................................................... ..........


6. 3. Uninstall ip|reporter web ............................................. ..........
6. 4. Uninstall ip|export ........................................................ ..........

2-62
2-62
2-62

CHAPTER 3 SOFTWARE LICENSE TERMS ......................... ..........


1. GRANT OF RIGHTS TO USE AND INTELLECTUAL
PROPERTY ........................................................................ ..........
2. OPEN SOURCE LICENSES ............................................... ..........
3. TERM AND TERMINATION ................................................ ..........
4. SOFTWARE MEDIA WARRANTY ...................................... ..........
5. SOFTWARE WARRANTY ................................................... ..........
6. DISCLAIMER ...................................................................... ..........
7. GOVERNING LAW .............................................................. ..........

3-1
3-1
3-1
3-1
3-2
3-2
3-2
3-3

CHAPTER 4 TECHNICAL SUPPORT ..................................... ..........


1. CUSTOMER TECHNICAL SUPPORT ............................... ..........

4-1
4-1

February 2012

Ipanema Technologies

ii

INTRODUCTION
1. REVISIONS
Date of issue

Index

Chapter/
section
concerned

Subject

December 2011

All

The information contained in this document was


included in the User manual up to 6.0 software
version.
It is a manual of its own as of v7.0.

December 2011

All

GA version of the manual.

February 2012

All

Minor corrections.

2. LIST OF ASSOCIATED DOCUMENTS


This document describes Ipanema system installation on Windows.

To know the compatible software versions (ip|boss / ip|agent), the supported hardware, the
end-of-life status, the bug fixes and functional limitations, please refer to the CMS Release
Notes v7.0.
To configure and use the system, please refer to the User Manual 7.0.
It is provided on ip|uniboss / ip|boss installation DVD-ROM in the \doc directory, in PDF
format.
To use the Command Line Interface, refer to the Ipanema System CLI Reference Manual 7.0.
It is provided on ip|uniboss / ip|boss installation DVD-ROM in the \doc directory, in PDF
format.
For each range of ip|engine (10, 100 and 1000), there is a Configuration manual, that
describes their technical characteristics, the installation procedure, the configuration and
set-up procedures and the main troubleshooting commands.
It also contains the ip|engines Directives, Regulations and Certificates.
Read the SAFETY INSTRUCTIONS before connecting an ip|engine to the supply.
This manual is intended for ip|engines integrators, administrators and users.

3. DOCUMENT ORGANIZATION
This document contains four chapters:

Chapter
Chapter
Chapter
Chapter

February 2012

1
2
3
4

- ip|uniboss and ip|boss installation


- ip|reporter installation
- Software license terms
- Technical support

Ipanema Technologies

Ipanema System

4. TERMS USED
Domain:

A Domain is composed of a set of ip|engines measuring, controlling


and optimizing the traffic, globally on the Domain. Domains are
managed with ip|uniboss.
ip|engines are configured and operated via ip|boss.

GUI:

Graphic User Interface.

IP:

Internet Protocol.

LAN:

Local Area Network.

SALSA:

Scalable Application Level Service Architecture.

SNMP:

Simple Network Management Protocol.

WAN:

Wide Area Network.

5. CMS IDENTIFICATION
Ipanema Central Management Software v7 refers to:

ip|uniboss v7.0,
ip|boss v7.0 (ip|uniboss and ip|boss are installed via the same installer),
ip|reporter v6.0:
InfoVista 4.2 build 42094,
Rollup 4.2 IVS-14199 (for VistaFoundation 0),
ip|export v6.0.

ip|reporter web v6.1:


VistaPortal SE 4.2 build 42065.

Ipanema Iphone App v1.2 (IOS version >= 4.3.2).

Ipanema Technologies

February 2012

CHAPTER 1. IP|UNIBOSS AND IP|BOSS


INSTALLATION
Document organization
There is no installation to perform for SALSA client (it is a web application which
connects to ip|uniboss server) or for ip|dashboard (it is a web application which
connects to ip|boss server).

1. 1. SALSA ARCHITECTURE
The SALSA architecture encompasses all components of the Ipanema system, which run in
client/server mode. The servers processes supervise the system. The clients are the Graphical
User Interfaces (GUI).

The servers
There are four servers in the SALSA architecture, ip|uniboss, ip|boss, the Web server and
ip|reporter. The last one is explained in the next Chapter.
ip|uniboss server manages the Domains, the Users (LDAP directory) and the License.
It manages accesses to ip|boss and ip|reporter web, by authenticating and redirecting
the Users.
ip|boss server is multi-profiles and multi-accesses, thus allowing different rights for
each User (no access, read only or read/write access for each function: System
administration, Service activation, Supervision, Helpdesk, etc.). It manages the
communications with the ip|engines (supervision, configuration, start/stop of their
services, collect of the Correlation records every minute or every 5 min), and it has an
SNMP interface.
The Web server allows to access ip|uniboss and ip|boss servers through a web client.
The three servers (ip|boss, ip|uniboss and the Web server) are completely
independent: they can run on the same station or on different stations (preferably on
the same LAN).

The clients
There are five clients: SALSA, ip|uniboss, ip|boss, ip|dashboard and ip|reporter web. The
last one is explained in the next Chapter.
SALSA client connects to ip|uniboss server and gives a unified access to ip|uniboss,
ip|boss, ip|dashboard and ip|reporter web clients.
ip|uniboss client allows to modify the Domains (creation, modification and deletion), to
manage the Users (with different access rights on ip|uniboss, ip|boss and ip|reporter
web), to manage the License (verification and upgrade) and to run an inventory of the
configured Domains. It should be on a different station from the server (on the same or
on a different LAN).
ip|boss client allows to modify the configuration: adds, deletions in the different
dictionaries, start or stop order, display of measurements in real-time, creation of
Metaviews and reports. It should be on a different station from the server (on the same
or on a different LAN).
The Users can access SALSA, ip|uniboss, ip|boss and ip|dashboard GUIs with a
web browser (Internet Explorer or Mozilla Firefox; no installation is required).
CLI clients are also available (they need an installation on the station, see below).
Java clients are available too, but they are not supported any longer (they need an
installation on the station, see below).
ip|dashboard is only accessible via a web client.

February 2012

Ipanema Technologies

1-1

Ipanema System

SALSA architecture (with InfoVista VF0 platform)

1-2

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

1. 2. PREREQUISITES
Before installing ip|uniboss and ip|boss servers, please check whether the following software are
installed, and install them if they are not:

Microsoft Visual C++ 2008 SP1 Redistributable (x86) Package (vcredist_x86.exe installer is
provided in windows\redist),
Microsoft Visual C++ 2008 SP1 Redistributable (x64) Package (vcredist_x64.exe installer is
provided in windows\redist),
Java Development Kit 1.6 (jdk-6u27-windows-x64.exe installer is provided in windows\java),

(The directories mentioned above refer to ip|uniboss/ip|boss installation DVD-ROM. They are
also available as a zip file from our Support web site.)
Java must NOT be upgraded after ip|uniboss or ip|boss installation. Make sure the
automatic updates are disabled: go to Control Panel > Java > Advanced tab > JRE
Auto-Download and select Never Auto-Download:

If these steps are already performed, you can skip this section and jump to 1.2.
Otherwise, please follow the installation procedures below.

February 2012

Ipanema Technologies

1-3

Ipanema System

1. 2. 1. Microsoft Visual C++ 2008 SP1 Redistributable


Microsoft Visual C++ redistributable packages are normally installed on most Microsoft servers.
Yet, if its not the case, the two installation software (one for x86 and one for x64) are available on
Ipanema installation DVD-ROM, here: windows\redist.
If you have installed previous pre-release versions of Visual C++ 2008 SP1 such as Beta
1 or Community Technical Preview (CTP) builds, then you must uninstall these versions
via Programs and Features in Control Panel before installing the final released version.

1. 2. 1. 1. Microsoft Visual C++ 2008 SP1 Redistributable (x86) installation


Installation procedure:

Launch the vcredist_x86.exe installer and follow the on-screen instructions:


If a Security Warning window appears (during a remote installation for instance), click Run:

In the next window, click Next:

1-4

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

In the License Terms window, check the box I have read and accept the license terms. and
click Install:

Microsoft Visual C++ installation then proceeds.


When installation is completed, a message is displayed. Click Finish:

1. 2. 1. 2. Microsoft Visual C++ 2008 SP1 Redistributable (x64) installation

Launch the vcredist_x64.exe installer and follow the on-screen instructions.


The five steps are strictly identical to the ones described above.

February 2012

Ipanema Technologies

1-5

Ipanema System

1. 2. 1. 3. Verification
In Control Panel > Programs and Features, you should now see the two Microsoft Visual C++ 2008
SP1 Redistributable software:

1-6

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

1. 2. 2. Java Development Kit 1.6


To check the Java software version, in a DOS window enter the java -version
command.

Install JDK

To install the Java Development Kit 1.6 (if needed), in ip|uniboss/ip|boss installation
DVD-ROM go to \windows\java directory and launch jdk-6u27-windows-x64.exe.
If a Security Warning window appears (during a remote installation for instance), click Run:

In the next window, click Next:

February 2012

Ipanema Technologies

1-7

Ipanema System

In the next window, click Next:

JDK installation then proceeds.


In the next window, click Next:

1-8

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

JDK installation then completes. Click Finish:

An Internet Explorer then opens and proposes to register your JDK. Do as you like.

In Control Panel > Programs and Features, you should now see the two Java software:

February 2012

Ipanema Technologies

1-9

Ipanema System

Java must NOT be upgraded after ip|uniboss or ip|boss installation. Make sure the
automatic updates are disabled: go to Control Panel > Java > Advanced tab > JRE
Auto-Download and select Never Auto-Download:

1-10

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

1. 3. INSTALL IP|UNIBOSS, IP|BOSS AND WEB SERVERS


1. 3. 1. Specifications for the servers
The software application runs on a server (or a workstation with enough power):

Microsoft Windows Server 2008 SP2 64 bits,


Microsoft Windows Server 2008 R2 (64 bits) (recommended).
Support is limited to these specific versions of the 64-bit Windows Operating
Systems, because it is also necessary to install the following Microsoft hotfix:
http://support.microsoft.com/kb/2253063.

Please refer to the relevant Release note to check the minimum characteristics required.

1. 3. 2. Install ip|uniboss, ip|boss and the web servers


ip|uniboss server, ip|boss server and the Web server can be installed at the same
time and on the same station, or they can be installed separately on different stations.
In this manual, the procedure describes the installation of the three servers on the same
station. If you want to install only one or two of them on a station, follow this procedure,
and skip the steps with a screenshot that you do not see during your installation.
To install ip|uniboss, ip|boss or the web server, you must be connected as an
administrator on the server (installation of services).
To install ip|uniboss, ip|boss or the web server using the Command Line Interface,
please refer to the relevant Technical Note (only the standard procedure is described
here).

February 2012

Internet Information Services Web Server must be stopped.


Other services or applications using port 443 (HTTPS) must be stopped.
LDAP port (389) must be available.
MySQL port (3306) must be available.
To install ip|uniboss or ip|boss server, JDK 1.6 must be installed on the station
(see above). If JDK is not installed, or if the installed version is incorrect, an error
message will be displayed and the installation will not proceed.

Ipanema Technologies

1-11

Ipanema System

Procedure to install ip|uniboss, ip|boss and the web server software:

Connect as administrator on the server.


Insert the installation DVD-ROM. The installation software starts automatically; otherwise
launch ipboss_setup.exe in the directory /windows/install.
If a Security Warning window appears (during a remote installation for instance), click Run:

If the installer had already been launched, a Warning window asks you whether you want to
proceed (click Continue) or if you want to abort (click Exit). You should select Exit and wait for
the other copy of the installer to start.

Alternatively, if this is due to a previous failed installation attempt, please proceed as follows:
click Exit,
check that no SALSA service is running (Start > Administrative Tools > Services, and
stop the ones that are running, if any),
check that the installation program is not running (Start Task Manager > stop javaw.exe,
if running),
check that no salsa folder is present in C:\Program Files (if the previous
installation had been launched with the default path) and delete it, if it is,
clear the temporary files (C:\Windows\Temp),
relaunch the installer.

1-12

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

In the installation welcome window, click Next:

In the next window, indicate the directory of installation (C:\Program Files\salsa by


default) and click Next:

If the directory does not exist, it is created; click OK to confirm:

If the directory already exists, you are warned that existing files may be overwritten; click
Yes to confirm, if this is what you want to do:

February 2012

Ipanema Technologies

1-13

Ipanema System

The following window allows you to select the packs you want to install: ip|boss, ip|uniboss
and Web server for Windows. The three are selected by default. Uncheck the packs you do not
want to install and click Next:
The three servers can be installed separately on different stations.
In this manual, the procedure describes the installation of the three servers on the
same station. If you want to install only one or two of them, uncheck the boxes
corresponding to the servers that you do not want to install and follow the rest of
this procedure, skipping the steps with a screenshot that you do not see during your
installation.

Close the Services window, if opened, before continuing the installation.

In the next window you must specify the JDK location path. If Java was installed in the default
directory, it should be C:\Program Files\Java\jdk1.6.0_27\. Click Next when done.

If the directory is not set correctly, an error message is displayed:

1-14

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

Services are configured and cleaned.


You have nothing to do here, as this window does not need to be acknowledged: do
NOT click Next, but wait for the next window to be displayed.

In the next window, select the Domains location path (uni_boss folder).
This window only appears if ip|uniboss is being installed, and if it is a first-time
installation.
The default path is:
C:\Program Files\salsa\uniboss\server if ip|uniboss is installed alone, or
C:\Program Files\salsa\ipboss\server if it is installed with ip|boss.

Whether ip|uniboss is installed alone or with ip|boss, the customers Domains


will always be created on the server that runs ip|boss, in C:\Program
Files\salsa\ipboss\server\domains by default.

February 2012

Ipanema Technologies

1-15

Ipanema System

Click Next. In the next window, you can modify the following parameters:

TCP Ports Settings:


ip|uniboss hostname or IP address (127.0.0.1 by default); this field does not
appear when performing the installation locally;
LDAP TCP port (389 by default),
Salsa server TCP port (443 by default).
Administrator account:
Create a default user check box (selected by default): to create a default user.
When selected, the three following fields can be modified:
User name (administrator by default),
Password and Confirm password (admin by default).
After you have changed the parameters, of if you want to leave the default values, click Next to
continue.
Do not click Next again before the next window appears.

1-16

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

In the next window, some parameters can be set for the database used by ip|dashboard and
Ipanema iPhone application (there is one database per ip|boss server, and they contain one
table per Domain):
This window only appears if ip|boss is being installed, and if it is a first-time
installation.
The Ipanema system is provided with an embedded MySQL database.
External MySQL databases are NOT supported.

Do NOT modify the four next parameters.

Database embedded checkbox (selected by default): you MUST NOT change this
parameter (by deselecting this box and by setting the three following parameters, it will
allow to declare an external MySQL database, but this is not supported in this version);
MySQL Database hostname (127.0.0.1 by default): external MySQL database, not
supported in this version; this parameter cannot be modified (as long as you do not
deselect Database embedded);
Admin user login (root by default): external database administrator login, not supported
in this version; this parameter cannot be modified (as long as you do not deselect
Database embedded);
Admin user password (set by default): external database administrator password, not
supported in this version; this parameter cannot be modified (as long as you do not
deselect Database embedded);
The five next parameters all have default values; we recommend you NOT to change
them.
Database port (3306 by default);
ip|boss administrator user password (set by default): password for the MySQL database
administrator;
Owner user password (set by default): user who can create/modify/delete the Domains
tables;
ip|boss user password (set by default): user who will feed the data in the tables;
REST user password (set by default): user you can read the data (ip|dashboard or
iPhone application).

February 2012

Ipanema Technologies

1-17

Ipanema System

In case of missing parameters, an error window displays the error message:

When all the parameters are set, or if you want to leave the default parameters (recommended),
click Next.
The installation program proceeds.
You should avoid using the [Previous] button as of this step.

Click Next when finished.


Database user grants are updated, SALSA services are installed and started:
You have nothing to do here, as these windows do not need to be acknowledged:
do NOT click Next, but wait for the next window to be displayed.

1-18

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

Select a Program Group for the shortcuts and click Next:

When done, a success message is displayed; you can choose to generate an automatic
installation script if you wish. Click Done to complete installation and close the window:

February 2012

Ipanema Technologies

1-19

Ipanema System

1. 3. 3. Connecting to SALSA
Once the servers are installed, you can connect to SALSA with the following URL:
https://<ip|uniboss server>/salsa
(or https://127.0.0.1/salsa from ip|uniboss server itself).
If you see a Certificate error, click on Continue to this webpage to continue.
In the login window, type in your User name and password (default are administrator/admin, unless
you changed these setting on installing the server see above):

The first time you connect to the SALSA client, as no Domain is created, you are directly connected
to ip|uniboss:

1-20

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

To be able to use ip|uniboss and create Domains, it is necessary to have a running


license (refer to the User manual, Section 2.4 Import a license).
To start ip|boss, it is necessary to have an active Domain (refer to the User manual,
Chapter 2 MANAGING DOMAINS...).

For more information on how to use SALSA, ip|uniboss, ip|boss and ip|dashboard
clients, please refer to the User manual.

February 2012

Ipanema Technologies

1-21

Ipanema System

1. 3. 4. SALSA services
The setup process of the three servers has created and started five new services (or less on each
station, if the three servers were installed on different stations):

SALSA Apache: SALSA portal (reverse proxy listening on port 443, connected to ip|boss,
ip|uniboss and ip|reporter web),
SALSA Apache Directory Server: Unified User Management (LDAP),
SALSA ipboss Server,
SALSA ipuniboss Server (manages the start of the different processes),
SALSA Web Server: ip|boss and ip|uniboss web interface (Tomcat); it is used by the previous
service.

Make sure the services are configured in recovery mode (Restart the Service after the first, the
second and the subsequent failures):

1-22

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

To start, restart or stop a service:

Connect as administrator on the server,


Select the service you want to start, restart or stop,
Click on:

to start the service (if stopped),

to restart the service (if started),

to stop the service (if started).

February 2012

Ipanema Technologies

1-23

Ipanema System

1. 3. 5. SALSA folders
The setup process has created the following directory tree:
The tree shown here was created with ip|boss, ip|uniboss and the Web server installed
on the same station. If they are installed on different stations, each station will house a
part of it only (but with the same folders structure).

When ip|boss and ip|uniboss are installed on the same station (case here):
both the Domains concentrator (uni_boss) and the Customers Domains are under
C:\Program Files\salsa\ipboss\server\domains
(the Customers Domains folders are created on creating the Domains with ip|uniboss).

When ip|boss and ip|uniboss are installed on different stations:


the Domains concentrator is under
C:\Program Files\salsa\uniboss\server\domains on ip|uniboss server,
the Customers Domains are under
C:\Program Files\salsa\ipboss\server\domains on ip|boss server.

1-24

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

1. 4. INSTALL SALSA, IP|UNIBOSS AND IP|BOSS CLIENTS


SALSA, ip|uniboss and ip|boss have three clients: web, Java and CLI. The Java clients are still
provided, but they are not supported any longer.
ip|dashboard has one client: web.

1. 4. 1. Install SALSA, ip|uniboss and ip|boss web clients


No installation is necessary for SALSA, ip|uniboss or ip|boss web clients.
Windows Internet Explorer 7, 8 and 9, and Mozilla Firefox 3.6 or higher are supported
(IE 9 or Firefox 8 are recommended).

1. 4. 2. Install SALSA, ip|uniboss and ip|boss Java clients


The Java clients are still provided, but they are not supported any longer. Their
installation and utilization are not mandatory (all features are available via the web
clients) and not recommended.
The Java clients run on:

Windows,
Solaris,
Linux.

1. 4. 2. 1. Prerequisites
The Java clients require Java Runtime Environment 1.6. JRE installation is described in this manual
in the ip|reporter installation section, in 1.5 version: please follow the same procedure but with JRE
1.6, that you can download from the Internet (http://java.sun.com).
There must be no proxy installed:

check your web browser parameters (Tools > Internet Options > Connections > LAN
settings: check boxes must be blank (Windows));
check Java web start preferences
(C:\Program Files\Java\jre6\bin\javaws.exe then File / Preferences /
General / Proxies: none (Windows))

1. 4. 2. 2. Install SALSA Java client


It is possible to use ip|uniboss and ip|boss Java clients without SALSA Java client,
so this installation is not required.
It runs on the same machine as the server. Should you want to use it on a remote
desktop, you must update the salsa_portal.jnlp file in:
\salsa\uniboss\web_server\webapps\salsa_manager\app
and replace 127.0.0.1 by the IP address of the server in
<property name="LDAP_URL" value="ldap://127.0.0.1:389/">
before installing the client.

February 2012

Ipanema Technologies

1-25

Ipanema System

Launch your web browser (Internet Explorer / Mozilla Firefox), and select the following
URL: https://x.x.x.x:10443/salsa_manager (wherex.x.x.x is the IP address of
ip|uniboss server; the use of HTTPS is mandatory). A warning may tell you that the publisher
is unknown; click Yes to continue:

In order to launch the installation of SALSA java client, click on Start Salsa Portal rich client
and open the link target (salsa_portal.jnlp file) with Java Web Start Launcher.
Warning messages on the web sites certificate (Security or Hostname mismatch)
may appear. Please ignore them, click Yes or Run, according to the message, to
continue.
The Java client is then loaded:

1-26

A shortcut for SALSA is created on your desktop:

Now SALSA Java client is installed, the starting screen appears:

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

To launch the client complete the following fields in the Login window and click Validate:
Server: IP address of ip|uniboss server
User name: administrator by default
Password: with administrator account the default password is admin

SALSA Java client main window opens:

SALSA Java client main window

If no Domain was created, only ip|uniboss is accessible.

if ip|uniboss server is upgraded, the software upgrade of SALSA Java client is


automatically handled by the Java Web Start Software when launching SALSA Java
client.

February 2012

Ipanema Technologies

1-27

Ipanema System

1. 4. 2. 3. Install ip|uniboss Java client

There are two different ways to launch ip|uniboss Java client installation, either with or without
SALSA Java client (only this first step differs):
To install ip|uniboss Java client using SALSA Java client, double-click on ip|uniboss
image in SALSA Java client main window (it opens at the end of the installation
procedure, refer to the previsous section):

SALSA Java client main window


To install ip|uniboss Java client without SALSA Java client, launch your web
browser (Internet Explorer / Mozilla Firefox), and select the following URL:
https://x.x.x.x:10443/ipuniboss_manager (where x.x.x.x is the IP
address of ip|uniboss server; the use of HTTPS is mandatory). A warning may tell you
that the publisher is unknown; click Yes to continue:

1-28

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

Click on Start ip|uniboss rich client and open the link target (ipuniboss_manager.jnlp
file) with Java Web Start Launcher.
In either case, warning messages on the web sites certificate (Security or
Hostname mismatch) may appear. Please ignore them, click Yes or Run,
according to the message, to continue.

ip|uniboss Java client is automatically downloaded and installed, the starting screen appears:

A Java message may warn you that the digital signature has been verified. Click
Run to run the application.

To launch the client complete the following fields in the Login window and click Ok:
Server: IP address of ip|uniboss server
User name: administrator by default
Password: with administrator account the default password is admin

ip|uniboss Java client main window opens:

ip|uniboss Java client main window

February 2012

Ipanema Technologies

1-29

Ipanema System

All icons except About and Exit are greyed out on first installation. To use ip|uniboss,
you need a running license (refer to the User manual, Section 2.4 Import a license).
if ip|uniboss server is upgraded, the software upgrade of ip|uniboss Java client is
automatically handled by the Java Web Start Software when launching ip|uniboss Java
client.

1-30

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

1. 4. 2. 4. Install ip|boss Java client

There are two different ways to launch ip|boss Java client installation, either with or without
SALSA Java client (only this first step differs):
To install ip|boss Java client using SALSA Java client, double-click on ip|uniboss
image in SALSA Java client main window:

SALSA Java client main window


To install ip|boss Java client without SALSA Java client, launch your web
browser (Internet Explorer / Mozilla Firefox), and select the following URL:
https://x.x.x.x:10443/ipboss_manager (where x.x.x.x is the IP address of
ip|uniboss server; the use of HTTPS is mandatory). A warning may tell you that the
publisher is unknown; click Yes to continue:

Click on Start ip|boss rich client and open the link target (ipboss_manager.jnlp file)
with Java Web Start Launcher.

February 2012

Ipanema Technologies

1-31

Ipanema System

In either case, warning messages on the web sites certificate (Security or


Hostname mismatch) may appear. Please ignore them, click Yes or Run,
according to the message, to continue.

ip|boss Java client is automatically downloaded and installed, the starting screen appears:

A Java message may warn you that the digital signature has been verified. Click
Run to run the application.

To launch the client complete the following fields in the Login window:
Server: IP address of ip|uniboss server
User name: administrator by default
Password: with administrator account the default password is admin

and click Ok.

ip|boss Java client main window opens:

ip|boss Java client main window

1-32

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

To start ip|boss client, it is necessary to:

have a running license (refer to the User manual, CHAPTER 2. MANAGING


DOMAINS / 2.4. IMPORT A LICENSE),
have an active Domain (refer to the User manual, CHAPTER 2. MANAGING
DOMAINS); otherwise a message tells that you have no access to any domain:

If ip|boss server is upgraded, the software upgrade of ip|boss Java client is


automatically handled by the Java Web Start Software when launching ip|boss Java
client.

February 2012

Ipanema Technologies

1-33

Ipanema System

1. 4. 3. Install ip|uniboss and ip|boss CLI clients


For detailed information concerning ip|boss and ip|uniboss Command Line Interface
clients, please refer to Ipanema System CLI Reference Manual 7.0.pdf (provided on
the installation DVD-ROM).
ip|boss and ip|uniboss have a specific GUI client each, that uses CORBA over SSL to
communicate with a dedicated client request handler.
Quite similarly, there is a CLI client for ip|boss and a CLI client for ip|uniboss. They communicate
exclusively with their respective CLI connector using CORBA over SSL. The best image to illustrate
what the CLI clients and CLI connectors are is to compare the CLI clients to Telnet clients and the
CLI connectors to remote shell services.
The CLI clients can be downloaded from the ip|boss web server using the following URLs:

https://x.x.x.x:10443/ipboss_cli for the ip|boss CLI client,


https://x.x.x.x:10443/ipuniboss_cli for the ip|uniboss CLI client (where x.x.x.x is
the IP address of ip|uniboss web server).

By clicking on the link (depending on your system), you will be asked to open or save a zip archive
named:

ipboss_cli_win32.zip, ipboss_cli_solaris.zip or ipboss_cli_linux.zip for ip|boss client,


ipuniboss_cli_win32.zip, ipuniboss_cli_solaris.zip or ipuniboss_cli_linux.zip for ip|uniboss
client.

These zip archives have some files in common. It is possible to unzip them in the same directory.
Unzip the archive you need, depending on your system, and launch the executable file it contains:

1-34

ipmcli.exe or ipmcli for ip|boss client,


ipmunicli.exe or ipmunicli for ip|uniboss client.

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

You are then prompted for:

the server address (127.0.0.1 will be used if you enter no value),


the port (9999 will be used if you enter no value),
the user (no default means you have to enter a value; the default user is administrator),
the password (the default password for the administrator account is admin).

A message tells you when you are logged in to ip|boss CLI client.
The prompt turns to ipmcli@<Domain_name> (ip|boss client) or ipmunicli@<Domain_name>
(ip|uniboss client).
The CLI clients currently use no external settings whatsoever, no startup file, no registry. Just
download the binaries to some directory, unzip the archive and make sure to have that directory in
your PATH.
For Solaris you will also need to add that directory to your LD_LIBRARY_PATH. As an
alternative, you can create a launcher script like:
#!/bin/sh
IPMCLI_DIR=<some directory>
# Use absolute path here
LD_LIBRARY_PATH=$IPMCLI_DIR:$LD_LIBRARY_PATH
export LD_LIBRARY_PATH
$IPMCLI_DIR/ipm[uni]cli $*
Call that script ipm[uni]cli and put it into any directory that is in your PATH (usually
/usr/local/bin). Make sure you add execute permissions to that script for anyone who is
to use it.

CLI client/server compatibility


The CLI client/server communication protocol, the CLI client and the CLI connector have
been designed with upwards and backwards compatibility in mind. As a consequence, it
is safe to use any CLI client with any CLI server, no matter the versions and/or platforms.
The client and the server exchange version information prior to the login request,
and they exchange protocol version offers in the login request itself. During protocol
version negotiation, the more recent peer is supposed to present itself as the most
recent version of itself, the older peer has knowledge of, that usually is the older peers
version.
As a result, the client and the server version offer usually refer to the same protocol
version.

February 2012

Ipanema Technologies

1-35

Ipanema System

1. 5. UNINSTALL THE IPANEMA SOFTWARE APPLICATIONS


The uninstallation of ip|uniboss/ip|boss consists in uninstalling the ip|uniboss, ip|boss and web
server programs and, if installed on the server, the SALSA, ip|uniboss and ip|boss Java clients.

1. 5. 1. Uninstall ip|uniboss and ip|boss servers


To uninstall ip|uniboss/ip|boss servers and the Domains, you must be connected as
administrator on the server.
If ip|uniboss server or ip|boss server or the web server are installed separately on
different machines, follow the same procedure on each machine.
If ip|uniboss and ip|boss servers are installed on the same machine, the installation
procedure will uninstall both.

SALSA services must be stopped before uninstalling:

SALSA Windows Services

1-36

Launch uninstall located in Start > All Programs > ipboss.


Select Force the deletion of C:\Program Files\salsa and click Uninstall:

When done, click Quit:

Ipanema Technologies

February 2012

ip|uniboss AND ip|boss installation

1. 5. 2. Uninstall SALSA, ip|uniboss and ip|boss clients


The only clients you may want to uninstall are the Java clients.
The procedure is the same for the three of them:

Launch javaws -viewer from the menu Start > Run:

A Java window opens, with all programs installed:

Click on the application you want to uninstall and click Remove selected items (red cross).
If you want to uninstall Java on the server, select the menu Start > Control Panel >
Program and Features, select Java in the program list and click Uninstall

February 2012

Ipanema Technologies

1-37

CHAPTER 2. IP|REPORTER INSTALLATION


Document organization
To install ip|reporter on Solaris, please refer to the relevant Technical notes.

2. 1. IP|REPORTER ARCHITECTURE
According to InfoVistas platform being used, VistaFoundation 0 (VF0) or VistaFoundation 4 (VF4),
there are two different possible architectures.

2. 1. 1. ip|reporter architecture with InfoVista VF0 platform


ip|reporter runs in client/server mode. The server processes (InfoVista) collect data from ip|boss
SNMP agent. The rich client (IVreport) is the GUI (graphical user interface) that allows to set
InfoVista parameters and to show the reports.
The reports can also be visualized through a web client, using VistaPortal SEs web server (refer
to the next section, ip|reporter web).

ip|reporter architecture with InfoVistas VF0 platform

February 2012

Ipanema Technologies

2-1

Ipanema System

2. 1. 2. ip|reporter architecture with InfoVista VF4 platform


The VistaFoundation 4 is an ensemble of InfoVista products working in conjunction with each other
in a N-tier architecture:

ip|reporter architecture with InfoVista VF4 platform

Administration: VistaCockpit provides a centralized view of the distributed system and thus
helps to maintain a coherent configuration over the life time of the project. From the Cockpit
console, an administrator can configure components in a homogeneous fashion, debug the
system, and automate the administrators tasks (such as debugging data, InfoVista Server
backup, etc.)
Consolidation: this layer consists of just one product, VistaMart, which models the service,
provisions InfoVista Servers accordingly (load balancing between the servers), and stores
the collected data that subsequently go to the presentation layer in an Oracle database; this
is where the configuration and the dashboard data are stored. VistaMart controls groups of
InfoVista servers, which can spread over different systems.
Data collection: InfoVista servers use SNMP to obtain the data from ip|boss SNMP agent,
store the collected data in ObjectStore databases and and push them to VistaMart using HTTP.
This is where the real time reports are stored.
Presentation: the collected data are presented to Users in VistaPortal in pages that form
together a management dashboard. Alerts show up directly in VistaPortal, and you can obtain
real-time data by drilling-down from higher-level summary reports.

All components connecting to InfoVista servers (i.e. VistaMart and VistaPortal) must use the Port
Mapper (default port 1275). See the InfoVista Server Administration Guide or the relevant Ipanema
Technical Note for complete connection details.

2-2

Ipanema Technologies

February 2012

ip|reporter installation

2. 2. PREREQUISITES
To install ip|reporter, you must have Administrator privileges because the installation
program installs Windows services.

Before installing ip|reporter server, please check whether Java Runtime Environment 1.5 (or
higher) is installed, and install it if it is not (jre-1_5_0_15-windows-i586-p.exe installer is provided
on the installation DVD-ROM, in redist\win32\java).
For ip|reporter and ip|reporter web, you should optimize your computer for applications and
not for file sharing.

2. 2. 1. Java Runtime Environment 1.5


To check the Java software version, in a DOS window enter the java -version
command.

To install Java Runtime Environment 1.5 (if needed), in ip|reporter installation DVD-ROM go
to the redist\win32\java directory and launch jre-1_5_0_15-windows-i586-p.exe.
In the window that opens, choose the Typical setup and click Accept:

February 2012

Ipanema Technologies

2-3

Ipanema System

JRE installation then proceeds:

When installation is completed, a message is displayed. Click Finish:

2. 2. 2. Optimize your computer for applications


Before installing, and for optimal performance of ip|reporter and ip|reporter web on a Windows
server, it is important to optimize your computer for applications and not for file sharing.
To optimize a Windows server for network applications:

2-4

Use the menu Start > Control Panel > Network and Sharing Center > Local Area
Connection,
open the property sheet (Properties button),
open the File and Printer Sharing for Microsoft Networks property sheet,
select the last option: Maximize data throughput for network applications.

Ipanema Technologies

February 2012

ip|reporter installation

2. 3. INSTALL IP|REPORTER (VF0)


ip|reporter processes numerous high added value reports which fully leverage all the power of the
Ipanema System.
ip|reporter is powered by InfoVista.

ip|reporter supports two versions on InfoVistas platforms, VistaFoundation 0 (VF0)


and VistaFoundation 4 (VF4). This manual only describes the installation of ip|reporter
with VF0. The installation of ip|reporter with VF4 is performed, and must be certified,
by Ipanema.
It includes an embedded InfoVista runtime license which carries out all the user interface functions
locally, remotely in client/server mode, or through an HTML interface using VistaPortalSE
ip|reporter web.
All the configuration tasks are carried out automatically by the ip|reporter module. Therefore, the
installation of the product is straightforward and its usage is very simple.

2. 3. 1. Specifications for ip|reporter server


The software application runs on a server:

Microsoft Windows Server 2008 SP2 64 bits,


Sun Solaris 10 (SPARC station).

Memory, processor and disk requirements vary according to how you use InfoVista software,
notably in terms of database size. Please refer to the relevant Release notes to check them.
Always install ip|reporter server on a dedicated machine (in case of a small
configuration ip|boss and ip|reporter can be on the same machine).

ip|reporter rich client (IVreport) can be installed on systems running under Windows XP SP1 or
higher.
For more information on Operating System requirements, please refer to the README file (you
can open it, once InfoVista is installed, by selecting Start > All Programs > InfoVista > Readme >
InfoVista Readme) and to the CMS Release Notes.

2. 3. 2. Multi network interfaces


In the case where you have a server with several network interfaces, CORBA uses the first network
interface it finds for the current host. You can change this:

by setting the usable host IP address to IV_HOST_IPADDRESS


Example IV_HOST_IPADDRESS=10.1.12.248
This is the recommended way for version 3.1.
by setting ORBendPointPublishAllIFs to 1. This second solution makes the binding to all
the non-loopback interfaces of the host.

These settings must be made on the server machine.

February 2012

Ipanema Technologies

2-5

Ipanema System

2. 3. 3. VMWare
InfoVistas licence is attached to the MAC address of the server. As a consequence, if you are
running a VMWare server, you must set its MAC address (it is dynamic by default, and it can change
after a reboot for instance).

2. 3. 4. Install ip|reporter with InfoVista VF0 platform


The installation of ip|reporter with InfoVista VF0 platform on Windows systems contains three
steps:

Step 1. Install InfoVista 4.2 on ip|reporter server. If InfoVista is already installed, it is not
mandatory to reinstall it if the version is identical (see the build number and the instructions of
the Release notes):

insert ip|reporter DVD-ROM in ip|reporter server DVD-ROM drive;


launch Setup.exe in DVD-ROM:\infovista\win32;
follow the on screen instructions (see the detailed installation procedure in 2.3.3.1);
if there is a hot fix folder in the ip|reporter package, install it (see 2.3.3.2);
in the event of a problem, refer to the README.HTM file in DVD-ROM:\infovista, or
check Windows Event viewer (see 2.3.3.4).

Step 2. Load Ipanemas VistaViews in InfoVista (see the detailed installation procedure in 2.3.4):
insert ip|reporter DVD-ROM in ip|reporter server DVD-ROM drive;
launch ipreporter_setup.exe in DVD-ROM:\win32;
follow the on screen instructions and set the appropriate parameters;
or (the second procedure is only helpful to perform a remote installation, or when Java is not
installed on ip|reporter server):
use InfoVista rich client to manually load the VistaViews on each InfoVista instance.

Step 3. Install the description file of the report templates on ip|boss server (see 2. 3. 8):
insert ip|reporter DVD-ROM in ip|boss server DVD-ROM drive;
launch ipreporter_setup.exe in DVD-ROM:\win32;
follow the on screen instructions;
or (the second procedure is only helpful to perform a remote installation):
manually copy the file reports_desc.ipmsys on ip|boss server (in Program
files/salsa/ipboss/server/conf).

Infovista software protection


The InfoVista server software and VistaViews are protected by a license key. This determines the
period of time you can access the server and the VistaViews:

For an evaluation or demonstration period, use the EVAL key. This allows you to access the
server for a period of 30 days starting from your first connection to the server,
For an extended evaluation or an unlimited period, you need a license key provided by Ipanema
Technologies. Refer to the Obtaining License key section below.
If you are using an evaluation key, you are unable to connect to the InfoVista server
and to access the reports in the VistaView after the evaluation period. However, the
collected data are not lost and new data continue to be collected. You are able to access
the reports again after entering a valid server and VistaView license key.

2-6

Ipanema Technologies

February 2012

ip|reporter installation

2. 3. 4. 1. Install InfoVista 4.2, first-time installation


This section and the two following ones describe the first step in ip|reporter three-step
installation procedure.

There are two possible installation procedures:

first-time installation, described here,


upgrade, described in 2.3.3.3.

A first-time installation does the following:

installs the InfoVista software;


imports the pre-loaded VistaViews into the InfoVista server database;
installs the Perl Integration Toolkit (SDK).

Procedure

Insert the ip|reporter DVD-ROM into your DVD drive.


To start the procedure:
either, from the Task bar:
select Run,
enter (this assumes the DVD-ROM is in drive D:):
D:\infovista\win32\setup.exe,
press Enter
or, in the Windows Explorer: double-click the Setup.exe program in the DVD-ROM
directory \infovista\win32.

February 2012

Ipanema Technologies

2-7

Ipanema System

2-8

Click Next to accept the InfoVista license agreement:

We recommend taking a look at the Readme file before installing:

Ipanema Technologies

February 2012

ip|reporter installation

You are prompted to complete the following fields:

Name

any string of characters

Company Name

any string of characters

License key

if you have a license key, enter it here. If not, leave the evaluation key
EVAL, which allows you to use the software for 30 days

Click Yes to accept configured license:

February 2012

Ipanema Technologies

2-9

Ipanema System

The Select Components window allows you to specify which software components are to be
installed. To add a component, check the box to the left of its name. By default, all components
are checked. You can also specify a different destination disk or directory in this window.
the Server Components and Client Components software packages are both selected
for installation by default. To install only one or the other, uncheck the box to the left of
the item you do not wish to install,
the Online Documentation component copies to disk the InfoVista core documentation in
PDF format. These files can be opened (with Acrobat Reader software) in IVreport using
the Help/Contents option or alternatively Start/Programs/InfoVista/Documentation.
the Perl Integration Toolkit component installs a Perl scripting-language extension
(in <InfoVista installdir>\SDK\Perl by default), which allows you to include InfoVista
commands in Perl scripts, providing a convenient means to automate data import and
export in the InfoVista environment.
See the Readme file for more details on the installation of the Perl Software
Development Kit.

2-10

In the same window, select the installation directory according to local IT rules. Note that this is
where the ObjectStore transaction log will be installed by default (it can be moved afterwards):

Ipanema Technologies

February 2012

ip|reporter installation

Set the name of the InfoVista Server instance to install (20 characters maximum) (first
installation only). By default, the first server instance you install is called iv1, and we
recommend sticking to the default naming. This name is used by the Service Manager and
allows you to identify a given server instance when multiple servers are installed.

Depending on sizing choices, InfoVista Manager and Collector databases may be stored on
different drives. Choose the path that suits your infrastructure (first installation only). Manager
and Collector databases for a single instance should be kept together. Database names
are based on the server instance name defined in the previous step (manager_iv1.db and
collector_iv1.db by default).
You can also modify the name and path of the log directory (by default: <installdir>\log).
Default directories
The default InfoVista installation directory is C:\Program Files\Infovista\Essentials. It is referred
to as <installdir>.
InfoVista software modules are installed in the following directories, by default:

Installation:

<installdir>\
This is the main directory. You can change it by clicking on the
Browse button in the Select Components window.

InfoVista Manager and


Collector:

<installdir>\data\
This directory contains the manager.db file, responsible for
updating the InfoVista Information System model and the
collector.db file, which stores polled data.
Note: Upgrades of existing 3.2 installations do not allow database
directory changes.

February 2012

Ipanema Technologies

2-11

Ipanema System

InfoVista log files:

<installdir>\log\
InfoVista log files are installed in this directory.
To change the location of the Manager/Collector database files
or the log directory, modify the paths displayed in the Server
directories window.
Note: Upgrades of 3.0 do not propose a change in the log
directory.

InfoVista Online
Documentation:

<installdir>\doc\
Acrobat PDF-format documentation files are copied here.
The installation of Acrobat Reader is not proposed
during the installation process, but the software is
provided on the DVD-ROM. You must install this
software to be able to read PDF-format documentation
files provided with InfoVista. To install Acrobat
Reader (version 5), execute:win32acr-505.exe from
DVD-ROM:\infovista\redist\acrobat\win32

2-12

Accept directory creation (click Yes twice):

Ipanema Technologies

February 2012

ip|reporter installation

For each InfoVista server endpoint, you can set a port number (first installation only). If you
leave the default (Automatic), the system randomly chooses an appropriate endpoint.
If you use a multiple IV Server instance configuration, it is no longer mandatory to
specify the endpoint, except if you managed your servers with VistaCockpit 1.1.

Manager Endpoint: the TCP port number used to access the InfoVista Manager.
Collector Endpoint: the TCP port number used to access the InfoVista Collector.
Browser Endpoint: the TCP port number used to access the InfoVista Browser.
By default, these three values are automatically generated by InfoVista.
If there is a firewall between the InfoVista client-server systems, it is necessary to
use a fixed port number. Consult your firewall administrator to determine an available
port number and enter it here.
With InfoVista Server 4.2, you can connect to a server with a connection string using
the instance name in the case of a multi-server installation. See the InfoVista Server
Users Guide, Communicating with the server for additional information.

In the next window:


Select Typical to proceed with a standard ObjectStore installation.
Select Custom only if you require the ObjectStore Transaction log file to be located
other than in the InfoVista installation directory.

February 2012

Ipanema Technologies

2-13

Ipanema System

ObjectStore Transaction log file: all ObjectStore transactions are recorded in a log file
which is, by default, stored in the same location as the collector and manager databases:
<installdir>\data\ossvrtxn.log.

2-14

The installer asks you if you want to install InfoVista Cockpit agent; do not click the box and
proceed (this agent only needs to be installed with VistaFoundation 4 platform; please refer to
the corresponding installation technical note as described above).

Ipanema Technologies

February 2012

ip|reporter installation

The installer informs you that it will add the name InfoVista to your list of Program Folders. You
can, if you wish, modify this name or select another one from the list of existing Folders.

The next screen sums up installation choices:

Click Next. Installation should now be running.


Files are copied to disk at this point.
Click Finished to end the installer process.

February 2012

Ipanema Technologies

2-15

Ipanema System

Installation Directories
After installation or upgrade, the following directories are created or upgraded in the installation
directory (\InfoVista\Essentials):

2-16

bin:

InfoVista binary executable

data:

ObjectStore databases

doc:

documentation in PDF format.

etc:

resources used by the ObjectStore executables

lib:

resources used by the executables

log:

InfoVista log files

mibs:

MIB files

sdk:

programming extensions for Perl and C. HTML documentation is included


for the Perl API

VViews:

the two automatically installed VistaView XML files (Core and Tuning)

Ipanema Technologies

February 2012

ip|reporter installation

2. 3. 4. 2. Install InfoVista hot fix


This is part of the first step in ip|reporter three-step installation procedure.
If there is a hot fix listed in the CMS release notes (then there is a hot fix folder in the ip|reporter
package), you have to install it:

1. Start command window (Start > Run > type in cmd);


2. Change directory:
cd C:\Program Files\InfoVista\Essentials\registry\hotfixes\bin
3. Type in install.bat <full path to hotfix hxz file>
(for instance, if the DVD-ROM is inserted in drive D: :
install.bat D:\infovista\rollup-IVS-14889.hxz).

2. 3. 4. 3. Moving from InfoVista 3.2 or 4.0 to 4.2


The procedure is the same as the first time installation, except that some steps are skipped.

When going from InfoVista Server version 3.2 or 4.0 to version 4.2, there is no need for a
migration of data. This is an automatic upgrade that modifies the database schema, attributes,
and model. It does not impact the data.
See the InfoVista Server Users Guide or Ipanema Technical notes for information about
database migration.

Important recommendations

It is strongly recommended to make a backup of your databases before starting the installation
procedure. Refer to the relevant Ipanema Technical Note for details.
As the trap format has changed and more precisely the information provided (manager and
browser endpoints), it is mandatory to upload the new InfoVista core libraries in your InfoVista
server.

2. 3. 4. 4. Installation troubleshooting
This is part of the first step in ip|reporter three-step installation procedure
In the event of a problem, the Windows Event Viewer can be used to obtain detailed incident
information.
To access the Event Viewer:

select Start > Administrative Tools > Event Viewer from the Task bar.

February 2012

Ipanema Technologies

2-17

Ipanema System

2. 3. 5. Install VistaViews
This is the second step in ip|reporter three-step installation procedure.
There are two ways to install the Ipanema VistaViews: an automatic procedure, using
ipreporter_setup.exe executable file, and a manual procedure, using IVreport (InfoVista rich
client).
The manual procedure is only helpful to perform a remote installation, or when Java is not installed
on ip|reporter server. Otherwise, follow the automatic procedure.

2. 3. 5. 1. Automatic installation (using ipreporter_setup)

2-18

Insert ip|reporter DVD-ROM in ip|reporter server DVD-ROM drive,


Launch ipreporter_setup.exe from the DVD-ROM, in /win32.

Click Next. In the next window, accept the terms of the license and click Next:

Ipanema Technologies

February 2012

ip|reporter installation

In the next window, there are two check boxes, one for ip|boss server and one for InfoVista
server.
If only ip|reporter is installed on this server, only the InfoVista server check box is
checked, by default: leave it as it is.
If only ip|reporter is installed, but if you have mapped a network drive to ip|boss on
this server, you may check the ip|boss server and browse ip|boss main directory
(~/salsa/ipboss/server by default) to install the reports description on ip|boss server
at the same time; this procedure is explained separately in this document, as the third
step of ip|reporter server installation, so we assume that ip|boss server is not checked
in the rest of the procedure.
If both ip|boss and ip|reporter are installed on this server, both boxes are checked by
default: uncheck ip|boss server if you want to install the VistaViews only; leaving this
box checked would allow you to install the reports description on ip|boss server at the
same time; this procedure is explained separately in this document (see above).
InfoVista installation path is automatically detected and displayed in the field InfoVista main
directory (e.g. C:/Program Files/InfoVista); correct it if it does not match the actual installation
directory.
The installer automatically detects the presence of a VistaFoundation 0 environment and
will configure the templates for it (it would offer additional options in a VistaFoundation 4
environment):

February 2012

Ipanema Technologies

2-19

Ipanema System

2-20

Select the libraries you want to install and then click Next.
To know which InfoVista libraries you have to install (1m5m, 1m15m or 5m15m), check the
configuration of your Domains on ip|uniboss. 1m15m, for example, corresponds to a Short
reporting period set to 1 minute and a Long reporting period set to 15 minutes. The Short
reporting period (1 or 5 min) and the Long reporting period (1, 5 or 15 min) of your Domains
must correspond with the libraries you install. If ip|uniboss has not been installed yet, or if no
Domain has been configured, we advise you to use the default values (1m15m).

The installation then proceeds. Click Next when finished:

Ipanema Technologies

February 2012

ip|reporter installation

A message tells you that the installation tasks were successful; click Next:

In the next window,


select the InfoVista instances where you want to apply the new VistaViews libraries (they
are automatically detected, and their boxes checked by default),
type the InfoVista administrator login (administrator by default) and password (no
password by default),
tick the Purge Trash Libraries to automatically delete the old libraries,
then click on the Import button to import the VistaViews (during the previous installation
steps, they were copied on the server, but not imported in InfoVista database).

February 2012

Ipanema Technologies

2-21

Ipanema System

Click Next when finished.

Click Done to finish the installation:

2. 3. 5. 2. Manual installation (using IVreport)

Start IVreport (InfoVista rich client) and connect to the first instance.
Menu File/install VistaView.
Select all libraries located in one of the following directories (and one only) on ip|reporter
DVD-ROM:
ivl/1m5m if the Short and Long reporting periods are the default ones, 1 and 5 minutes
respectively,
ivl/1m15m if the Short reporting period is at 1 min and the Long reporting period has
been increased to 15 min,
ivl/5m15m if the Short and Long reporting periods have been increased to 5 and 15
min respectively.

2-22

(To read more information on the short and long reporting periods, refer to the User manual
section 3.6.1 Create a Domain.)
Click on the Install button.
Close IVreport.
Repeat all previous steps for each InfoVista instance.

Ipanema Technologies

February 2012

ip|reporter installation

2. 3. 5. 3. Upgrading VistaViews
To upgrade the Ipanema Technologies Vistaview, you must load them with IVreport.

Start the InfoVista graphic client.


Menu File/install VistaView.
Select all libraries located in one of the following directories (and one only) on ip|reporter
DVD-ROM:
ivl/1m5m if the short and long reporting periods are the default ones, 1 and 5 minutes
respectively,
ivl/1m15m if the short reporting period is at 1 minute and the long reporting period has
been increased to 15 minutes,
ivl/5m15m if the short and long reporting periods have been increased to 5 and 15
minutes respectively.

(To read more information on the short and long reporting periods, refer to the User manual,
Chapter MANAGING DOMAINS, USERS AND LICENSES (ip|uniboss), section SYSTEM
PROVISIONING > Domains > Create a Domain.)
Click on the Install button.
Purge the Trash Libraries.
Close.

The new versions of VistaViews are NOT automatically updated. To avoid holes in report graphs
at critical times, we recommended you perform the upgrade in off-peak hours.

2. 3. 6. InfoVista services
The installation program sets the following Windows services to Automatic:

InfoVista Browser R4.2 iv1*


InfoVista Collector R4.2 iv1
InfoVista Manager R4.2 iv1
InfoVista Port Mapper R4.2
ObjectStore Cache Manager R7.0
ObjectStore Server R7.0.
* iv1 is the default suffix for the first instance of InfoVista. If more than one instance
is installed, the three services Browser, Collector and Manager will appear more than
once, with iv2 suffix (by default) for the second instance, iv3 for the third one, etc.

They are started automatically at system startup. After installation, if the services are not running,
start them manually.
After an upgrade, services are set to the status (stopped, started) and to the same startup type
(manual, automatic, disabled).
If you experience server problems, check the status of these services. If any of these them have
been stopped, you should restart it:

select Start > Administrative Tools > Services from the Task bar,
click the Start button for each service to be restarted.

February 2012

Ipanema Technologies

2-23

Ipanema System

2. 3. 7. Starting and Stopping InfoVista server and rich client


The next step after installation or upgrade is to check that both the server and client are functioning
correctly.

2. 3. 7. 1. Starting the Server


InfoVista server is started automatically after installation (and at each system reboot). However,
you may need to stop and start the server manually. The server requires 6 services if one InfoVista
instance is installed, more is several instances are installed (see above). To start or stop them:

select Start > Administrative Tools > Services from the Task bar,
select each service in turn and click either the Start or Stop icon, according to what you intend
to do.

2. 3. 7. 2. Starting the Client


To start the InfoVista client select Start > All Programs > InfoVista > IVreport from the Task bar.
By default, the connection parameters are:
Server Name

name of the system running the InfoVista server. If the server is the
local system (the same system as the client), leave this parameter blank

User name

administrator

Password

blank. Change this password as soon as possible after startup

You can connect to a server with a connection string using the instance name. See
the InfoVista Server Users Guide, Communicating with the server for additional
information.
During a client connection attempt, the server license key is checked against the known
MAC address on the NIC (Network Interface Card).

2-24

Ipanema Technologies

February 2012

ip|reporter installation

2. 3. 8. Obtaining License key


Associated information: Infovista software protection.

2. 3. 8. 1. Obtaining a full license key


To obtain a full license key, proceed as follows.

Step 1) Retrieve the MAC address of the server machine

Windows:

In the Task bar, select:


Start\Programs\Administrative Tools\Computer Management\System
Tools\System Information\ Components\Network\Adapter.
The MAC address is indicated in the column Values.

Solaris:

Login as: root


Enter: ifconfig -a
The MAC address is indicated in the line: ether: xx:xx:xx:xx:xx:xx
Alternatively, if the server has several network interfaces, you must use the ivsetkey
utility to know which MAC address to declare; the InfoVista software must be installed
first, using the EVAL license key, which is valid during 30 days.
On a VMWare server, make sure the MAC address is set.

Step 2) Answer Ipanema Technologies Supports email containing your ip|boss license and
indicate the MAC address in your answer (license@ipanematech.com).

Step 3) Ipanema Technologies generates and sends you the license key(s)
If you are requesting an unlimited key or you are moving or upgrading an existing unlimited
license, Ipanema Technologies generates and sends you the permanent key(s), which you
must enter in the software as described below.
It is possible to install the InfoVista software prior to obtaining the definitive license
key, using the 30-day evaluation EVAL key.

2. 3. 8. 2. Entering a new server license key


Use the IVSetkey utility to enter a new server license key:

On the server, in the Task bar, select:


Start > All Programs > InfoVista > Set License Key.
Enter your new license key
Click Set Key.

February 2012

Ipanema Technologies

2-25

Ipanema System

2. 3. 9. Reports description
To finish the installation of ip|reporter, you have to install the description of the report templates
on ip|boss server. This is the last step in ip|reporter 3-step installation procedure.
There are two ways to proceed: an automatic procedure, using ipreporter_setup.exe executable
file, and a manual copy of the file reports_desc.ipmsys.
The manual copy is only helpful to perform a remote installation. For a standard installation, follow
the automatic procedure.

2. 3. 9. 1. Automatic procedure (using ipreporter_setup)

2-26

Insert ip|reporter DVD-ROM in ip|boss server DVD-ROM drive,


Launch ipreporter_setup.exe from the DVD-ROM, in /win32:

Click Next. In the next window, accept the terms of the license and click Next:

Ipanema Technologies

February 2012

ip|reporter installation

In the next window, there are two check boxes, one for ip|boss server and one for InfoVista
server.
If only ip|boss is installed on this server, only the ip|boss server check box is checked,
by default: leave it as it is.
If both ip|boss and ip|reporter are installed on this server, both boxes are checked
by default: uncheck InfoVista server if you want to install the reports description
only; leaving this box checked would allow you to install the VistaViews on ip|reporter
server at the same time; this procedure is explained separately in this document as the
second step of ip|reporter server installation, so we assume that InfoVista server is
not checked in the rest of the procedure.
ip|boss installation path is automatically detected and displayed in the field ip|boss main
directory (e.g. C:/Program Files/salsa/ipboss/server); correct it if it does not match the actual
installation directory.
Click Next.

February 2012

Ipanema Technologies

2-27

Ipanema System

The installation then proceeds. Click Next when finished:

Click Done to finish the installation:

2. 3. 9. 2. Manual procedure (copy of the reports description)

2-28

On ip|boss server, start an explorer window,


insert ip|reporter installation DVD-ROM,
copy the file
DVD-ROM:\ipboss\reports_desc.ipmsys
to ~\salsa\ipboss\server\conf.

Ipanema Technologies

February 2012

ip|reporter installation

2. 3. 10. Backup and restore ObjectStore database (VF0)


To backup and restore ip|reporter with InfoVista VF4s Oracle database, refer to the
following Technical note:
TN-0100125-06_how_to_install_VistaFoundations4.1SP1_Windows.pdf
To backup and restore ip|reporter s database on Solaris, refer to the installation
manual IPANEMA-IRP-INSTALL-V[x].PDF (IRP stands for ip|reporter).

Regular backups of your database limits the quantity of data loss in the eventuality of hardware,
software, or human failures.
You can automate backups using the following tools:

NTBackup (Windows 2003 Server)


IVBackup binary provided for Solaris 10
osbackup in all other cases in which the above do not apply (and ONLY in other cases).

InfoVista Server 4.2 provides backup tools to facilitate the backup of a database (however
voluminous) if that should become necessary or inevitable.
The backup tools work at the file system level. They use a point-in-time technology based on file
system technologies provided by Microsoft (Volume Shadow Copy) and Sun (fssnap, delivered
with Solaris 10).
These technologies enable the performance of a point-in-time copy of data with minimal impact on
applications. Basically it performs a snapshot of a partition in a few minutes. During that time, the
InfoVista server must maintain the databases consistent (i.e. no write operations performed).
The advantage of these backup tools are:

No report outages
Reports always available for viewing

To use the backup tools, it is mandatory that the manager and collector databases of an InfoVista
server instance are stored on the same partition.
Backup procedure overview
The following section gives a general guideline by which to proceed when performing a backup.
See the section addressing your specific platform for precise details.
Usage
When an InfoVista Server is started, it registers the manager and collector database as VSS aware
with the Volume Shadow Copy Service.
Following this startup, you can use NTBackup to perform the backup of InfoVista databases.
Simply create your NTBackup task and schedule it.
With InfoVista registered with the Volume Shadow Copy Service, when you start a backup,
InfoVista automatically performs a checkpoint of the corresponding server. It automatically
performs a checkpoint when the snapshot is complete, before it releases the server checkpoint.
In addition to NTBackup, you can also use any other backup tool that supports Volume Shadow
Copy technology to back up your InfoVista databases.

February 2012

Ipanema Technologies

2-29

Ipanema System

2. 4. INSTALL IP|REPORTER WEB (VF0)


ip|reporter web is powered by InfoVista.

InfoVista VistaPortal Standard Edition is the web interface for viewing InfoVista reports.
The purpose of this chapter is to Install the VistaPortal SE version 4.2 on a Windows server.
ip|reporter supports two versions on InfoVistas platforms, VistaFoundation 0 (VF0) and
VistaFoundation 4 (VF4). In this section, installation of VistaPortal SE with VF0 only
is described. To install VistaPortal SE with VF4, please refer to the relevant Ipanema
Technical Note.
To install VistaPortal SE server on Solaris, refer to the installation manual
IPANEMA-IRPWEB-INSTALL-V[x].PDF (IRPWEB stands for ip|reporter web).

2. 4. 1. Specifications for ip|reporter web server (VPSE)


VistaPortal Standard Edition software application runs on a server:

Microsoft Windows Server 2008 SP2 64 bits,


Sun Solaris 10.

Always install VPSE on a dedicated machine.


Memory, processor and disk requirements vary according to how you use InfoVista software,
notably in terms of database size. Please refer to the relevant Release notes to check them.

2-30

Ipanema Technologies

February 2012

ip|reporter installation

2. 4. 2. Install ip|reporter web


This section explains how to install ip|reporter web with InfoVista VF0 platform on Windows
systems.
To install ip|reporter web with InfoVista VF4 platform, or on Solaris, refer to the relevant
Technical notes.

First check the requirements, memory configuration, etc. (see the three next sections), then insert
ip|reporter web DVD-ROM in ip|reporter web server DVD-ROM drive.
The installation of ip|reporter web contains two steps:

Step 1. Install VistaPortal SE on ip|reporter web server. If VistaPortal SE is already installed,


it is not mandatory to reinstall it if the version is identical (see the build number and the
instructions of the Release notes):

launch Setup.exe in DVD-ROM:\infovista\Disk1\InstData\Windows\VM;


follow the on screen instructions (see the detailed installation procedure in 2.4.2.5);
if there is a hot fix folder in the ip|reporter web package, install it (see 2.4.2.6);
check that you can connect to the server (see 2.4.2.7);
in the event of a problem, refer to the README.HTM file in DVD-ROM:\infovista.

Step 2. Customize ip|reporter web portal to set the Online mode, add a help for the reports,
delete the unused buttons and modify some settings. This will also set the Portal to Ipanema
colors:
launch ipreporterweb_setup.exe in DVD-ROM:\win32,
follow the on screen instructions and set the appropriate parameters (see the detailed
installation procedure in 2.4.2.8).

2. 4. 2. 1. Requirements
InfoVista 4.2 software must be installed. It can be anywhere on your network, but it should preferably
be in the same LAN as VistaPortalSE. The InfoVista client software does not have to be installed
on the same machine as VistaPortalSE.
For optimal performance of VistaPortal SE on Windows Server versions, you must ensure
that your computer is optimized for applications and not for file sharing (by default). See the
PREREQUISITES section above.

2. 4. 2. 2. Memory configuration
Recommended memory settings are proposed during the installation of the product. These
recommended settings depend on your servers memory.
You can however change values of Java server parameters after the installation in order to modify
the settings youve made at installation time.
This update shall also be made if youre adding memory to your VistaPortal SE Server. Note that
the maximum value supported by Java is 1024 MB on Windows server.
Offline Reporting
Change values of Java server parameters in the export script, as follows:

1. Open <installdir>/PortalSE/scripts/export.sh (or export.bat)


2. Edit the value of the variable JAVAMEMORY_FLAGS: -Xmx<NN>m
where the value of <NN> is equal to half the physical memory on the server (installed RAM);
e.g. NN = 1024 if the RAM is 2048 MB.
3. Save and close the file.

Online and Mixed mode Reporting

February 2012

Ipanema Technologies

2-31

Ipanema System

Change values of Java server parameters.

1. Open <installdir>/PortalSE/wrapper/wrapper.conf
2. Locate the lines
# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=512

3. Define the maxmemory value as half the physical memory on the server (installed RAM); e.g.
1024 if the RAM is 2048 MB.
4. Save and close the file.
5. Restart the VistaPortal SE server for the new changes to take effect.

2. 4. 2. 3. Client requirements and configuration


In order to view VistaPortal SE reports, client machines must have a supported web browser
installed and properly configured.
The supported versions of Web Browsers and Java Plug-ins are:

Internet Explorer 7 or 8
Important information regarding the "Click to activate this control" message are available
at http://msdn.microsoft.com/en-us/ie/bb969055.aspx.
With Internet Explorer the Microsoft Java Virtual Machine is no longer supported.

Firefox 3.5
Sun Java Plug-in: version 1.5.0_16, 1.5.0_22, 1.6.0_17, 1.6.0_20 or 1.6.0_27

VistaPortal SE will remain fully functional with more recent releases of these Web Browsers and
Java Plug-ins, as long as no regressions or important changes are introduced by such releases.
However, until intensive testing has been carried out on any new releases, they will remain
unsupported.
The Web Browser must be configured to:

Accept Cookies,
Enable Java and JavaScript,
Enable Popups from the VistaPortal SE website,
If you wish to view PDF-format reports, you must install the Adobe Acrobat Reader software
(Acrobat Reader version 6 or above), available in the /redist/adobe directory of the VistaPortal
DVD-ROM. To display PDFs in the Browser, the "Display PDF in Browser" option in the PDF
preferences has to be checked. If not, the PDF files will be opened in a separate Acrobat Reader
window.
If you wish to view Excel exports, Excel 2003 or greater must be installed.

Internet Explorer complementary settings

If the "Click to activate this control" messages appears in applets


Updates are available from Microsoft, please read
http://msdn.microsoft.com/en-us/ie/bb969055.aspx.
VistaPortal Standard Edition does not use Active X but instead only Java applets and Javascript;
nevertheless due to Microsoft implementation Active X execution has to be enabled:
Open the menu "Tools" / "Internet Options
In the Security tab, for the Internet zone select Custom Level button
Enable the option "ActiveX controls and plug-ins" -> "Script ActiveX controls marked
safe for scripting"
Check the parameter Use HTTP 1.1 through proxy connections in menu: "Tools /
Internet Options", Tab "Advanced", Section "HTTP 1.1"

If VistaPortal Standard Edition is installed using HTTPS, the web browser must allow encrypted
pages to be saved on disk in order to be able to save Report Data Exports (PDF, Txt, ...):
Open the menu "Tools" / "Internet Options"

2-32

Ipanema Technologies

February 2012

ip|reporter installation

Open the the "Advanced" tab


In the section "Security", uncheck "Do not save encrypted pages to disk".

Under Windows server, the VistaPortal Standard Edition website needs to be added in the
"Trusted Sites" list:

Open the menu "Tools" / "Internet Options"


In the Security tab, select the "Trusted Sites" icon
Click on the "Sites" button
Click on the Add button

In order to be able to display Excel exports when accessing VistaPortal Standard


Edition through the "Internet" zone, the following security setting must be enabled
(http://support.microsoft.com/kb/883255):
Open the menu Tools / Internet Options
In the Security tab, for the Internet zone select Custom Level button
Enable "Downloads -> Automatic prompting for file downloads" option

On Windows Server, Internet Explorer is setup by default not to play animations. No animated
images in VistaPortal Standard Edition are displayed. In order to see animations, Internet
Explorer must be set up with the following option:
Open the menu "Tools" / "Internet Options"
In the Advanced tab, for the Multimedia section check the Play animations in web
pages option.

2. 4. 2. 4. VPSE V2.2 uninstallation


This step is necessary only for a software update (not for a first installation of VistaPortalSE).

Stop Apache or IIS service


Stop the 2 Jrun services
Via Add/remove program in the configuration panel, uninstall VistaPortalSE V2.2
Via Add/remove program in the configuration panel, uninstall Jrun 3.0
Via Add/remove program in the configuration panel, uninstall Apache v2.2 or IIS 5 or 6
Check if java v1.5.0_11 is installed, if yes uninstall it
Reboot the server.

February 2012

Ipanema Technologies

2-33

Ipanema System

2. 4. 2. 5. VPSE 4.2 installation procedure


This is the first step of ip|reporter web twostep installation procedure.

Insert ip|reporter web 4.2 installation DVD-ROM and run the setup.exe application in
\infovista\Disk1\InstData\Windows\VM (normally automatically launched).
If a Security Warning window appears (during a remote installation for instance), click Run:

The welcome screen appears:

Do not forget to stop your web service (IIS or Apache) before continuing.

2-34

Click Next. The License Agreement window appears. After you have read and agreed to the
license terms, Click I accept... and click Yes.

Ipanema Technologies

February 2012

ip|reporter installation

The Setup README FILE window appears. This file contains the latest release notes, which
we recommend you to read.
If needed, click the Open in web browser button to direct the ReadMe to your favorite browser.
The information remains available in a separate window. Click Next.
The Choose Install Folder window appears to allow you to change the default installation
directory, if necessary. By default, VistaPortal is installed in C:\Program Files
(x86)\InfoVista. Click Next.
When the Install set window appears, check only Core components. Deselect the check box
Report samples. Click Next.

The Site Name window appears. Enter the name of the portal that users will access as a URL.
Our example uses the default name <PortalSE>. Click Next.

February 2012

Ipanema Technologies

2-35

Ipanema System

The Memory Settings window appears. Available memory is automatically detected and
a value is proposed for VistaPortal SE (= half of the physical memory of the server, with a
maximum of 1024 MB). Click Next.

If you are upgrading to newer version of VistaPortal SE you can keep the existing
memory settings, or set the maximum memory allocated to VistaPortal. We
recommend that you keep the existing memory settings.

InfoVista Cockpit Agent is not mandatory with InfoVista VF0 platform. Unclick the check box if
you do not want to install it. Click Next.

The Pre-Installation Summary page appears with summarized information about the
parameters you have entered. Click Install.
The installation starts. A progress bar indicates the progress of the installation.
The installer completes the installation of VistaPortal SE and displays a summary. Check if
warnings occurred during the install and read the logs, should it be the case.
Click Done to exit the installation window.

2-36

Ipanema Technologies

February 2012

ip|reporter installation

Installing JDK and Tomcat


Note that during the installation of VistaPortal SE 4.2, the setup automatically proceeds with the
installation of Java Development Kit components, JDK.
The installation continues with the installation of the Tomcat application server and the configuration
of the External Web Server.

2. 4. 2. 6. Install VistaPortalSE hot fix


This is part of the first step of ip|reporter web twostep installation procedure.
If there is a hot fix listed in the CMS release notes (then there is a hot fix folder in the ip|reporter
web package), you have to install it:

1. Start command window (Start > Run > type in cmd);


2. Change directory:
cd C:\Program Files (x86)\InfoVista\PortalSE\registry\hotfixes\bin
3. Type in install.bat <full path to hotfix hxz file> (for instance, if the
DVD-ROM is inserted in drive D: : install.bat D:\infovista\Hotfix VPSE 4.2
42065-VPS-4060\42065-VPS-4060.hxz).

February 2012

Ipanema Technologies

2-37

Ipanema System

2. 4. 2. 7. Connection to VistaPortal SE
This is the first step of ip|reporter web twostep installation procedure.
You should now be able to connect to VistaPortal SE by directly connecting to the server on
port 10080 (http://<ipreporter web server>:10080/PortalSE), assuming you left the
default parameters during the installation procedure:
This is not the standard way to connect: you should only follow this procedure to test
your installation.

Direct connection to VistaPortal SE

2-38

Ipanema Technologies

February 2012

ip|reporter installation

Click on the Connect button. A server connection form is then displayed:

Connection to ip|reporter server


The default Username is administrator, with no password (leave the field empty).

February 2012

Before you can connect to VistaPortal SE by selecting ip|reporter in the SALSA


client (standard connection), it has to be customized (see the next section).
If you want to connect to VistaPortal SE by using its legacy URL
(http://<ip|reporter web server>/PortalSE/) without specifying the
port number, a web server (Apache 2.2 or IIS 7.0) must be installed and configured.
(Indeed, SALSA Apache service will only listens on the port specified during
installation 10080 by default, so another web server is required; see the next
sections). Otherwise (for standard connections) no additional web server is
required.)

Ipanema Technologies

2-39

Ipanema System

2. 4. 2. 8. Customizing
This is the second step of ip|reporter web two-step installation procedure.
ip|reporter web portal must be customized to set the Online mode, add a help for the reports,
delete the unused buttons and modify some settings. This will also set the Portal to Ipanema colors.
This step is mandatory.

This customizing is done thanks to the ipreporterweb_setup.exe installer (provided on ip|reporter


web installation DVD-ROM, under \win32):

2-40

Launch ipreporterweb_setup.exe in DVD-ROM:\win32,


In the Welcome window, click Next:

Ipanema Technologies

February 2012

ip|reporter installation

In the Licensing Agreements window, select I accept the terms... and click Next:

In the Select Installation Packages window, uncheck ipreporter web for VistaPortal (only
ipreporter web for VistaPortalSE must be selected) and click Next:

February 2012

Ipanema Technologies

2-41

Ipanema System

2-42

In the Select InfoVista Target directories window, set InfoVista main directory (if it was
installed in the default directory, the path is C:\Program Files (x86)\InfoVista), select
the VistaPortalSE sub-directory (if it was not modified during VistaPortalSE installation, it is
PortalSE) and click Next:

In the next window, click Next:

Ipanema Technologies

February 2012

ip|reporter installation

Installation then proceeds. Wait until it finishes and click Next when finished:

In the next window, click Next:

Installation is now completed. You can generate an automatic installation script if you wish. Click
Done:

February 2012

Ipanema Technologies

2-43

Ipanema System

2. 4. 2. 9. Optional web server installation


A web server is required on Windows, but it does NOT need to be installed separately. Indeed,
when you access ip|reporter web through SALSA client, your web client connects to SALSA
Apache service on ip|uniboss server, then you are redirected to ip|reporter webs Tomcat server
application (Tomcat is automatically installed during the installation of VistaPortal SE 4.2).
But in case you would like to be able to directly connect to ip|reporter web (and not through SALSA
client) using its legacy URL (http://<ip|reporter web server/PortalSE by default), you
have to install an external web server on ip|reporter web server.
It is ONLY needed in that case. But in that case, this installation is required even if
ip|reporter web is installed on the same server as ip|uniboss or ip|boss, as a direct
connection will not use SALSA Apache service (indeed, the latter only listen on port
10080 by default).
One of the following can be used:

Apache 2.2.x for Windows (recommended): it is shipped on ip|reporter web DVD-ROM and
needs to be installed and configured manually after VistaPortal Installation (see below). Also
note that SSL support is not offered on Apache 2.2 for Windows.
Microsoft IIS 7.0 (not recommended): note that it needs to be configured manually after
VistaPortal SE Installation in order to be able to connect to the application (see InfoVista
documentation).

2. 4. 2. 9. 1. Apache 2.2 Installation

2-44

Insert ip|reporter web 4.2 installation DVD-ROM.


Run httpd-2.2.15-win32-x86-openssl-0.9.8m-r2.msi application in
infovista\redist\apache2.2\win32.
Follow the onscreen instructions (default installation):

Ipanema Technologies

February 2012

ip|reporter installation

2. 4. 2. 9. 2. Apache web server configuration


After the installation has finished, you have to configure Apache 2.2, if installed (to enable
connections to ip|reporter web using its legacy URL, see the note above).
If you are running IIS 7.0, you have to create a Web Service Extension. Please refer to
InfoVista documentation (provided on the DVD-ROM).
For more information on Tomcat connectors, please consult the documentation included
in the directory:
C:\Program Files\InfoVista\TomcatWebServerConnector\doc.
To configure Apache 2.2 on Windows with tomcat connectors, do the following:
Once Apache 2.2 has been installed (see above), edit the httpd.conf file in the directory
C:\Program Files (x86)\Apache Software Foundation\Apache2.2\conf\.
Locate the following section:
--------------------------------------------------------------------------# Dynamic Shared Object (DSO) Support
# To be able to use the functionality of a module which was built as a DSO
# you have to place corresponding LoadModule lines at this location so the
# directives contained in it are actually available _before_ they are used.
# Statically compiled modules (those listed by httpd -l) do not need
# to be loaded here.
#
# Example:
# LoadModule foo_module modules/mod_foo.so
--------------------------------------------------------------------------

After this section, add the following line (note: in this example, VistaPortal SE was installed
in C:\Program Files (x86)\InfoVista, which is noted ~: replace the symbol by the full
path):
--------------------------------------------------------------------------LoadModule jk_module "~\TomcatWebServerConnector\apache2.2\win32\mod_jk.so"
-------------------------------------------------------------------------- At the end of the configuration file, add the following lines (note: ~ stands for C:\Program
Files (x86)\InfoVista: replace the symbol by the full path):
--------------------------------------------------------------------------JkWorkersFile "~\TomcatWebServerConnector\conf\workers.properties"
JkMountFile
"~\TomcatWebServerConnector\conf\uriworkermap.properties"
JkLogFile
"~\TomcatWebServerConnector\logs\jk.log"
JkLogLevel emerg
JkShmFile
"~\TomcatWebServerConnector\logs\jk.shm"
-------------------------------------------------------------------------- Save the modifications.
Restart the Apache service.

You should now be able to connect to VistaPortal SE by using its legacy URL
(http://<ipreporter web server>:/PortalSE, assuming you left the default parameters
during the installation procedure). Please note this is not the standard mode: we normally connect
through the SALSA client (see the next section).

February 2012

Ipanema Technologies

2-45

Ipanema System

2. 4. 3. Connecting to ip|reporter web


If a Domain was created with ip|uniboss, you should now be able to connect to VistaPortal SE by
selecting ip|reporter in SALSA client:
https://<ip|uniboss server>/salsa

If no Domain was created, connecting to SALSA client automatically connects you to


ip|uniboss, which is the only piece of Ipanema software that you can use at this stage.
To see how to create a Domain with ip|uniboss, please refer to the User manual.
Make sure there is a compliant version of Java on the station that you use to connect
to the server (see 2.4.2.3 Client requirements and configuration, or refer to the Release
notes). Version 1.6.0_29, for instance, is NOT supported, and using it will oblige you to
log in again when you select ip|reporter among other issues.
You should now have an access to the Domains reports with ip|reporter web:

2-46

Ipanema Technologies

February 2012

ip|reporter installation

By expanding the menu in the left pane and by selecting a folder in the following hierarchy, you can
see the reports list:
<Domain> (here: Test) / <Type of MetaView> (Global) / <MetaView> (Domain)
/ <Time and privacy levels> (hour-private)

The folders structure and reports list are the same as in the Infovista rich client (IVreport). The
report access can be defined for each user with specific rules (see the User manual).
A help can be accessed by clicking on the Help button.
As long as no ip|engines are installed and declared in ip|boss, the reports will be empty (all the
data they display are coming from ip|engines measurements, with various types of aggregation).

February 2012

Ipanema Technologies

2-47

Ipanema System

2. 4. 4. VistaPortal SE 4.2 directory structure


This section describes the main directories and subdirectories in VistaPortal SE.

The PortalSE directory


The default installation procedure creates the \PortalSE subdirectory under the InfoVista
directory.
For the purposes of this manual, this installation directory is referred to as <installdir>. By
default, it is C:\Program Files (x86)\InfoVista\PortalSE.
The following subdirectories and files are used to create online and offline reports:

The controls subdirectory


After installation, this subdirectory contains the exportctrl.txt and portalsesetup.xml files which
are used to configure report exports and display.
This directory also contains the security.policy file used to define access rights for a user or a
group of users.
The files subdirectory
This contains the subdirectories for report files exported to VistaPortal SE. Sample
InfoVista reports are stored in the default subdirectory. The default location is
<installdir>\files\default.
The logs subdirectory
This contains:
the installation log files,
the server log files (wrapper.log, portalse.YYYY-WW.log)
a sub folder for the offline export log files.

2-48

Ipanema Technologies

February 2012

ip|reporter installation

The scripts subdirectory


This contains the scripts used by VistaPortal SE to export reports and to encode user
passwords.
The site subdirectory
This subdirectory contains the files used to run VistaPortal SE plus documentation, CSS and
HTML files for the VistaPortal SE interface.
The following subdirectories are located in the \site subdirectory.

classes

Contains the Java (JAR) files used to run the VistaPortal SE interface.

doc

Contains the VistaPortal SE Users Guide (this document) in PDF


format.

pages

Contains all of the HTML pages used in the VistaPortal SE interface.

styles

Contains the CSS files used by the VistaPortal SE interface and sub
folder with the default and customizable pages (welcome.htm).

WEB-INF

Contains files which deal with security activation and application


settings.

February 2012

Ipanema Technologies

2-49

Ipanema System

2. 5. INSTALL IP|EXPORT SOFTWARE


The purpose of ip|export is to automate scheduled data exports from InfoVista Server Database.
To see how to configure and use ip|export, please refer to the User manual.

ip|export is an optional module of ip|boss software suite, the use of this module is enabled by
ip|boss license file and requires ip|reporter module.
ip|export is delivered on a dedicated DVD-ROM, which contains the different software
components.
All the configuration tasks are carried out by modifying a single XML file. Therefore, the installation
of the product is straightforward and its usage very simple.

2. 5. 1. Specifications for ip|export


ip|export is based on ip|reporter server (InfoVista). However, it is possible, if needed, to execute
the files export on another machine.

2. 5. 2. ip|export process
ip|export process exports values from specified sets of existing indicators and instances and
produces outputs files on a given regular period.
All expected parameters by the process are given in input as an XML configuration file, which
contains a list of tasks. Each task describes an export action with filter expressions on Domain,
MetaView, Indicator names and many other parameters such as the type of output files, field
separator, schedule period, etc.
The process is installed on the target machine as a service, which means that the process starts
up after the machine has boot and stops just before the machine shutdown; it can be stopped and
restarted manually for maintenance or configuration purposes, but during this period it will not be
functional. However, as it stores the last execution time for each task, it can export intermediate
time slots if data are still available from the InfoVista Server database.
The only constraint to make the export process work is to have InfoVista collects on requested
indicators, which means that a report displaying the requested indicators must by running at all
time. Thus the export process does not create any additional load to InfoVista Server collector
process.

ip|export

2-50

Ipanema Technologies

February 2012

ip|reporter installation

2. 5. 3. Install ip|export
2. 5. 3. 1. Installation procedure
To install ip|export, you must be connected as an administrator on the server
(installation of Windows services).

Connect as administrator on the server,


insert the DVD-ROM and double click on the "ipexport_setup" icon, or execute the following
command line: <DVD-ROM>:\win32\ipexport_setup.exe.
The welcome window appears; read the information message and click on the Next button:

February 2012

Ipanema Technologies

2-51

Ipanema System

2-52

The license agreement appears; read it carefully, check the I accept the terms of this license
agreement radio button and click on the Next button:

In the next window, choose the target installation path on your machine, click on the Browse
button or type the path in the corresponding textfield then click on the Next button when done:

Ipanema Technologies

February 2012

ip|reporter installation

The next window shows the installation progress; wait until it finishes, then click on the Next
button:

The next window should confirm that the installation was successful; just click on the Done
button to close it and terminate the installation procedure:

February 2012

Ipanema Technologies

2-53

Ipanema System

Once installation is performed, you can check that the following files have been correctly installed
on your machine:
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport
<ipexport

2-54

dir>/readme.txt
dir>/version.txt
dir>/bin
dir>/bin/InfoVista.dll
dir>/bin/ipm_export.dtd
dir>/bin/ipm_export[.exe*] (*windows only)
dir>/bin/ivapi.[so|dll]
dir>/bin/msvcp71.dll (windows only)
dir>/bin/msvcr71.dll (windows only)
dir>/bin/sample.xml
dir>/Uninstaller
dir>/Uninstaller/uninstaller.jar

Ipanema Technologies

February 2012

ip|reporter installation

2. 5. 4. ip|export configuration
ip|export installation automatically creates a scheduled task on Windows and a cron entry on
Solaris, in order to call the ipm_export command line process every hour.
The command line process looks for a file called "ipm_export.xml" in the bin directory; by default
this file does not exist, however a "sample.xml" configuration file is given as an example. To make
ip|export work you need to create an ipm_export.xml configuration file and configure the export
tasks in this file.
The document type definition of this file is given in "ipm_export.dtd", so to be consistent the XML
configuration file should always start with the two following lines:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config SYSTEM "ipm_export.dtd">
The XML configuration file contains two parts:

the connections to InfoVista Servers (<ivservers> block) with, optionaly, renaming rules
(<renames> block),
the export tasks (set of indicators and of instances to export), using regular expressions
(<export> and <task> blocks).

A few words on XML


XML stands for eXtensible Markup Language. It is a markup language much like HTML, but
unlike HTML, which was designed to display data, XML was designed to structure, transport
and store data.
An XML file is made of blocks delimited by tags. XML tags are not predefined (the user must
define their own tags).
Example of a note stored as XML:
<note>
<to>Mike</to>
<from>Peter</from>
<heading>Reminder</heading>
<body>Our meeting starts in 10 minutes.</body>
</note>

2. 5. 4. 1. InfoVista Servers configuration


The <ivservers> block in the XML configuration file contains the connection information to InfoVista
servers, where ip|export tasks will connect to and export data. Their names are used as keys to
identify them.
The <instance> tag in the <ivservers> block specifies a new connection to an InfoVista server
instance; the InfoVista server instance should not be mistaken with an instance in the InfoVista
model.
Tag

Description

username

The administrator login name (mandatory)

password

The administrator login password (mandatory)

browserport

The browser port (optional)

collectorport

The collector port (optional)

managerport

The manager port (optional)


<ivservers> block

February 2012

Ipanema Technologies

2-55

Ipanema System

Example:
<ivservers>
<instance name="iv1@localhost">
<username>administrator</username>
<password></password>
<instance>
<instance name="iv2@localhost">
<username>administrator</username>
<password></password>
<instance>
</ivservers>
Optionaly, it is possible to rename indicators, thanks to a <renames> block within the <ivservers>
block:
Tag

Description

oldname

The old name string to be replaced

newname

The new name


<renames> block

Example:
<renames>
<indicator oldname="is - pm - vol - > site sessions"
newname="Sessions(ingress)" />
<indicator oldname="is - pm - vol - < site sessions"
newname="Sessions(egress)" />
</renames>

2. 5. 4. 2. Export tasks configuration


The <export> block in the XML configuration file defines the export tasks that need to be performed
by the process, with different kinds of filters and options; at the export level the following options
are described below:
Tag

Description

outputdir

Specify the output directory where output files are stored (mandatory).

splitbyparams

A boolean "true" or "false"; if true it will generate an output file per


parameter list. Default value is false.

splitbymetaview

A boolean "true" or "false"; if true it will generate an output file per


metaview. Default value is false.

splitbydomain

A boolean "true" or "false"; if true is will generate a subdirectory per


Domain. Default value is false.
<export> block

The tasks themselves are configured in <task> blocks within the <export> block. The tasks
parameters are described below:

2-56

Tag

Description

name

Name of the export task (mandatory).

Ipanema Technologies

February 2012

ip|reporter installation

scheduled

Scheduled export; it can take one of the following values: hourly / daily /
weekly / monthly.

format

The output file format; it can take on the following values: txt / csv / xls / xml.

dateformat

The output date and time format (2); if no date and time format is specified,
it uses the Epoch number (number of seconds since January 1st 1970).

isdatelocale

It can be "true" or "false"; by default it is false, which means that output


date and time refer to GMT(UTC); if it is turned to "true" then the date and
time refer to the defined local time zone of the machine.

fieldseparator

The field separator; it is meaningful with output text format only. Default
value is "|" (pipe). (1)

lineseparator

The line separator; it is meaningful with output text format only. Default
values are "\r\n on Windows and "\n" on Unix. (1)

paramseparator

The separator used for the list of parameters; default value is "," (comma).

arrangeindics

"column" or "line" (not available if output format is xml).

missingvalue

A character string to use in case of empty value. The default behavior is


an empty string.

ivserverfilter

A list of ivserver names. By default all ivservers listed in the ivservers


section are used (same syntax as for the ivservers tags).

domainfilter

A regular expression to filter on Domain names (3).

metaviewfilter

A regular expression to filter on MediaView names (3).

indicatorfilter

A list of indicators (4). It cannot be used with <reportfilter> tag, it exports


only indicators matching the given regular expression.

reportfilter

A list of reports; if omitted then all running reports are considered. It cannot
be used with <indicatorfilter> tag, it exports all indicators contained in the
subset of given reports. (3)
<tasks> block

(1) only available for output text format


(2) Date and time formats:
Tag

Replaced by

Example

%a

Abbreviated weekday name *

Thu

%A

Full weekday name *

Thursday

%b

Abbreviated month name *

Aug

%B

Full month name *

August

%c

Date and time representation *

Thu Aug 23 14:55:02 2010

%d

Day of the month (01-31)

23

%H

Hour in 24h format (00-23)

14

%I

Hour in 12h format (01-12)

02

%j

Day of the year (001-366)

235

%m

Month as a decimal number (01-12)

08

%M

Minute (00-59)

55

%p

AM or PM designation

PM

%S

Second (00-61)

02

%U

Week number with the first Sunday as the first day of week one (00-53)

33

February 2012

Ipanema Technologies

2-57

Ipanema System

%w

Weekday as a decimal number with Sunday as 0 (0-6)

%W

Week number with the first Monday as the first day of week one (00-53)

34

%x

Date representation *

08/23/10

%X

Time representation *

14:55:02

%y

Year, last two digits (00-99)

10

%Y

Year

2010

%Z

Time zone name or abbreviation

CDT

%%

A % sign

* The tags marked with an asterisk (*) are location-dependent.

(3) Regular expressions syntax:

2-58

Metacharacter

Description

Matches any single

Matches the preceding element zero or one time. For example, ba? matches "b" or "ba".

Matches the preceding element one or more times. For example, ba+ matches "ba", "baa",
"baaa", and so on.

The choice (aka alternation or set union) operator matches either the expression before or the
expression after the operator. For example, abc|def matches "abc" or "def".

[]

A bracket expression. Matches a single character that is contained within the brackets. For
example, [abc] matches "a", "b", or "c". [a-z] specifies a range which matches any lowercase
letter from "a" to "z". These forms can be mixed: [abcx-z] matches "a", "b", "c", "x", "y", or "z",
as does [a-cx-z]. The - character is treated as a literal character if it is the last or the first
(after the ^) character within the brackets: [abc-], [-abc]. Note that backslash escapes are
not allowed. The ] character can be included in a bracket expression if it is the first (after the ^)
character: []abc].

[^ ]

Matches a single character that is not contained within the brackets. For example, [^abc]
matches any character other than "a", "b", or "c". [^a-z] matches any single character that is not
a lowercase letter from "a" to "z". As above, literal characters and ranges can be mixed.

Matches the starting position within the string. In line-based tools, it matches the starting position
of any line.

Matches the ending position of the string or the position just before a string-ending newline. In
line-based tools, it matches the ending position of any line.

()

Defines a marked subexpression. The string matched within the parentheses can be recalled later.
A marked subexpression is also called a block or capturing group.

Matches the preceding element zero or more times. For example, ab*c matches "ac", "abc",
"abbbc", etc. [xyz]* matches "", "x", "y", "z", "zx", "zyx", "xyzzy", and so on. (ab\)* matches
"", "ab", "abab", "ababab", and so on.

{m,n}

Matches the preceding element at least m and not more than n times. For example, a{3,5}
matches only "aaa", "aaaa", and "aaaaa". This is not found in a few, older instances of regular
expressions.

Ipanema Technologies

February 2012

ip|reporter installation

(4) There are two ways to find the indicators syntax:

To see the indicators in the graph (or table) that you want to export, open the corresponding
report with IVreport, right click on the data to be exported and select Formulas:

To see all indicators in a report, open it with IVreport and select the Report / Properties menus:

In the window that opens, select the Advanced tab, and click on the Formats button:

February 2012

Ipanema Technologies

2-59

Ipanema System

All Indicators for the report are displayed in the Formats Advanced tab:

Use this table as read only information! Any modification in any field would mpact,
and possibly corrupt, the report!
Many indicators contrain < and > signs; in the XML configuration files <tasks>
block, they must be replaced by their codes:
replace < by &gt;
replace > by &lt;

If no report is defined then ipm_export tries to find collectors for the given indicators which
correspond to the smallest "display rate" period.
When starting the first time, ipm_export tries to export data from the begining of the current month
to the current defined period (hour, day, week or month).
All output files are produced under the directory specified in the "outputdir" parameter. An
"ipm_export.log" log file is also available; it tracks all ipm_export activity.

2-60

Ipanema Technologies

February 2012

ip|reporter installation

Example
Here is an example with three tasks:

Task 1: allsites: export every day for all domains (".*") and for all MediaViews containing
"Site:.*", all values for indicators that are about throughput "is - pm - throughput .*".
Task 2: alldomains: export every hour for all domains (".*") and for all MediaViews containing
"Domain", all values for indicators that are about volumes per site "is - pm - vol .* - site .*" and
"is - fi - availability .*".
Task 3: sla: export every hour for domain "MyDomain" and for all MediaViews containing
"Domain", all values for indicators that are about SLA per site "is - sla - dis - profile - site NQID SLA".

The corresponding XML configuration file should be like this:


<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config SYSTEM "ipm_export.dtd">
<config>
<ivservers>
<instance name="iv1@localhost">
<username>administrator</username>
<password></password>
<instance>
<instance name="iv2@localhost">
<username>administrator</username>
<password></password>
<instance>
</ivservers>
<export outputdir="C:\InfoVista\DataExport\" splitbyparams="false">
<task name="allsites"
scheduled="daily"
format="txt"
dateformat="%Y/%m/%d %H:%M:%S"
fieldseparator=",">
<domainfilter>.*</domainfilter>
<metaviewfilter>Site:.*</metaviewfilter>
<indicatorfilter>is - pm - throughput .*</indicatorfilter>
</task>
<task name="alldomains"
scheduled="hourly"
format="csv"
dateformat="%Y%m%d%H%M"
fieldseparator=";">
<domainfilter>.*</domainfilter>
<metaviewfilter>Domain</metaviewfilter>
<indicatorfilter>(is - fi - availability .*
|is - pm - vol .* - site .*)
</indicatorfilter>
</task>
<task name="sla"
scheduled="hourly"
format="xls"
dateformat="%d%_H%_M">
<domainfilter>MyDomain</domainfilter>
<metaviewfilter>Domain</metaviewfilter>
<indicatorfilter>is - sla - dis - profile - site - NQID SLA
</indicatorfilter>
</task>
</export>
</config>
To see the output directory and output files produced by ip|export, please refer to the section
EXPORTING THE REPORTS DATA WITH ip|export in the User manual.

February 2012

Ipanema Technologies

2-61

Ipanema System

2. 6. UNINSTALL IP|REPORTER AND IP|REPORTER WEB


To uninstall these components, you must be connected as administrator on the server
(removal of Windows services).

2. 6. 1. Uninstall VistaViews
When VistaViews are installed, InfoVista creates a library with the same name. To uninstall the
VistaView, delete the associated library as follows:

Start IVreport (InfoVista rich client);


In the left-hand pane of the main window, expand the Libraries node;
Select the library you want to delete;
Select Edit/Delete from the menu.

2. 6. 2. Uninstall ip|reporter
To uninstall ip|reporter, you have to unistall InfoVista:
Before doing so, close ivreport and ivstatus if they are running.

From the Task bar, select Start > Control Panel > Programs and Features;
Select InfoVista 4.2 and click Uninstall/Change (or Add/Remove, according to the version of
Windows) and follow the onscreen instructions;
If you do not intend to reinstall InfoVista, manually delete the directory C:\Program Files
(x86)\InfoVista (if it was installed in the default directory; if not, change the path
accordingly) and any files remaining in it.

2. 6. 3. Uninstall ip|reporter web


To uninstall ip|reporter web, you have to unistall VistaPortalSE:

Stop all Apache or IIS services;


From the Task bar, select Start > Control Panel > Programs and Features;
Select InfoVista VistaPortalSE 4.2 and click Uninstall/Change (or Add/remove, according to
the version of Windows) and follow the onscreen instructions;
If you want to uninstall Java, select it in the programs list (as per the previous step) and click
Uninstall/Change (or Add/remove);
If you want to uninstall the web server (Apache or IIS), select it in the programs list (as per the
previous step) and click Uninstall/Change (or Add/remove),
Reboot the server.

2. 6. 4. Uninstall ip|export

2-62

To uninstall ip|export, open a terminal or a console window and type the following command
line: java -jar <ipexport dir>/Uninstaller/uninstaller.jar.
The following dialog window appears; check the "Force the deletion of ...." check box to remove
the main target directory, then click on the Uninstall button:

Ipanema Technologies

February 2012

ip|reporter installation

Wait until the end of the uninstallation process, when the progress bar is completed, then click
on the Quit button to close the dialog box and finalize the uninstallation:

February 2012

Ipanema Technologies

2-63

CHAPTER 3. SOFTWARE LICENSE TERMS


Document organization
To use the Ipanema software modules (the Software), the End User must be granted a license
(the License) directly by Ipanema Technologies (Ipanema) or through a duly authorized reseller
(the Reseller). This License is defined by the following terms:

3. 1. GRANT OF RIGHTS TO USE AND INTELLECTUAL


PROPERTY
The rights granted to the End User to use the software is non-exclusive, non-transferable,
non-convertible and restricted to the use of the software for the exclusive purpose of installation
and operation of the Ipanema System in accordance with the recommendations and instructions of
Ipanema, issued in any form including the Ipanema technical documentation (theDocumentation).
Ipanema owns and shall retain all rights, title and interest in and to the Software and the
Documentation, and any copies, customized versions, corrections, bug fixes, updates,
enhancements, new versions, or other modifications to the Software, including all copyrights,
patents, trade secret rights, trademarks and other intellectual property rights therein. The license
granted under this Agreement does not provide the End User with title to, ownership of or any
proprietary right to the software and the documentation, but only a right of limited use according
to the terms of this License.
The right to use the Software does not include the right for copying, modifying, disassembling,
de-compiling, decoding, reverse engineering, or any derivative usage of the products, to the extent
permitted by applicable law.
According to software modules, the right to use is associated either with either a specific Ipanema
System configuration or by a certain number of ISUs (Ipanema Software Units) as described in
the commercial proposal or the contract.
The right to use software modules bound to ISUs within an Ipanema System can be transferred by
the End User to other such modules in the same Ipanema System as long as the corresponding total
number of ISUs is not exceeded. Any other modification of the configuration will modify the already
granted right to use and must be described in a subsequent commercial proposal or contract.

3. 2. OPEN SOURCE LICENSES


Some components of the Ipanema software may be covered under one or more of the open source
licenses below. The Ipanema warranty for these modules apply as they are used embedded in
the entire product. For licenses that require it, machine readable copies of modifications made
by Ipanema are available upon request. Complete license texts can be found at the following
addresses or by connecting to ip|engines (using the license command at login):

Apache License The Apache Software Licence, Version 1.1 and 2.0 http://www.apache.org
BSD 1.0 License http://opensource.org
GNU General Public License (GPL) Version 2, June 1991 http://www.fsf.org
GNU Lesser General Public License (LGPL) Version 2.1, February 1999 http://www.fsf.org

3. 3. TERM AND TERMINATION


The grant of this License is dependent on payment of the Initial Software License Fee, and shall
be effective as of the shipment date of the Software license key.
Should the End User fail to comply with any of the terms and conditions of this License, Ipanema
or its Reseller shall be entitled to terminate the License. Such termination shall be effective fifteen

February 2012

Ipanema Technologies

3-1

Ipanema System

(15) days after formal demand requiring correction of the breach shall have been sent by registered
post with return receipt requested without the breach having been so corrected.
In the event of termination of this license, the End User shall:

immediately de-install the Ipanema software;


pay to Ipanema or its Reseller all sums remaining due as at the date of termination.

3. 4. SOFTWARE MEDIA WARRANTY


Ipanema warrants that original data supports are free from defects in materials and workmanship,
assuming normal use, for a period of ninety (90) days from date of shipment.
Ipanemas sole and exclusive liability and the End Users sole and exclusive remedy under this
limited warranty shall be to replace the defective media on which the Software is recorded free of
charge. This remedy is available only if Ipanema is promptly notified in writing, within the warranty
period, upon discovery of the defect by the End User.

3. 5. SOFTWARE WARRANTY
Ipanema warrants that the software performs substantially according to its documentation for a
period of ninety (90) days from date of shipment of the software license key.
Ipanemas sole and exclusive liability and the End Users sole and exclusive remedy under this
limited warranty shall be, at Ipanemas election, to provide corrective maintenance services to
correct the Ipanema software if it doesnt perform as warranted within the warranty period or to
replace it free of charge with a corrected version.
The limited warranty set forth in this article shall not apply to any non conformity that is caused
by: (a) the End Users misuse or improper use of the software, including, without limitation, the
use or operation of the software with an application or in an environment other than that specified
by Ipanema, or introduction of data into any data structures or tables used by the software by any
means other than use of the software; (b) any third party software or hardware; (c) any modifications
or alterations of or additions to the software performed by parties other than Ipanema; or (d) the
End Users failure to implement all problem corrections and new releases.

3. 6. DISCLAIMER
THE EXPRESS REPRESENTATIONS, WARRANTIES AND CONDITIONS OF IPANEMA
SET FORTH IN THIS DOCUMENT ARE IN LIEU OF ALL OTHER REPRESENTATIONS,
WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED
TO, IMPLIED REPRESENTATIONS, WARRANTIES AND CONDITIONS OF MERCHANTABLE
QUALITY, MERCHANTABILITY, TITLE, DURABILITY OR FITNESS FOR A PARTICULAR
PURPOSE AND THOSE ARISING BY STATUTE OR OTHERWISE IN LAW OR FROM A COURSE
OF DEALING OR USAGE OF TRADE. IPANEMA DOES NOT REPRESENT OR WARRANT
THAT: (A) THE SOFTWARE WILL MEET END USERSS BUSINESS REQUIREMENTS; (B)
THE OPERATION OF THE SOFTWARE WILL BE ERROR-FREE OR UNINTERRUPTED; OR
(C) THAT ALL PROGRAMMING ERRORS CAN BE FOUND AND CORRECTED. THE END
USER IS RESPONSIBLE FOR TAKING PRECAUTIONARY MEASURES TO PREVENT THE
LOSS OR DESTRUCTION OF THE END USERS DATA, INCLUDING WITHOUT LIMITATION,
MAKING REGULAR BACKUPS AND VERIFYING THE RESULTS OBTAINED FROM USING THE
SOFTWARE, AND IPANEMA SHALL HAVE NO OBLIGATIONS OR LIABILITY WHATSOEVER
WITH RESPECT TO SUCH LOSS, DESTRUCTION OR USE UNLESS CAUSED BY THE
WILFUL MISCONDUCT OF IPANEMA.
WITHOUT LIMITING THE GENERALITY OF THE FOREGOING DISCLAIMERS, IPANEMA
EXPRESSLY DISCLAIMS ANY REPRESENTATIONS, WARRANTIES AND CONDITIONS
REGARDING THE PERFORMANCE CHARACTERISTICS OF THE SOFTWARE, INCLUDING
RESPONSE TIMES, MACHINE USAGE AND OTHER OPERATING CHARACTERISTICS, ON
ANY PARTICULAR COMPUTER EQUIPMENT. IPANEMA SHALL HAVE NO RESPONSIBILITY
FOR THE SELECTION, INSTALLATION AND MAINTENANCE OF THE COMPUTER
EQUIPMENT ON WHICH THE PROGRAMS AND THIRD PARTY SOFTWARE ARE TO
OPERATE.

3-2

Ipanema Technologies

February 2012

software license terms

FOR ANY BREACH OF THIS AGREEMENT OR ANY OTHER CLAIM ARISING FROM OR
RELATED TO THIS AGREEMENT GIVING RISE TO LIABILITY, IPANEMAS ENTIRE LIABILITY
SHALL BE LIMITED TO THE END USERS ACTUAL DIRECT, PROVABLE DAMAGES IN AN
AMOUNT NOT TO EXCEED IN THE AGGREGATE, THE TOTAL LICENSE FEES PAID BY THE
END USER FOR THE SOFTWARE THAT IS THE SUBJECT MATTER OF THE CLAIM.
IN NO EVENT SHALL IPANEMA OR ITS RESELLER BE LIABLE FOR LOSS OF PROFITS, LOSS
OF BUSINESS REVENUE, LOSS OF DATA, FAILURE TO REALIZE EXPECTED PROFITS OR
SAVINGS OR ECONOMIC LOSS OF ANY KIND, OR FOR ANY INDIRECT, CONSEQUENTIAL,
SPECIAL, INCIDENTAL OR PUNITIVE LOSSES OR DAMAGES, OR FOR ANY CLAIM AGAINST
END USER BY ANY OTHER PERSON, EVEN IF IPANEMA OR ITS RESELLER HAS BEEN
ADVISED OF OR COULD REASONABLY FORESEE THE POSSIBILITY OF ANY SUCH
DAMAGE OCCURRING.
THE LIMITATIONS SHALL APPLY REGARDLESS OF THE FORM OF ACTION, WHETHER
BASED ON CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, OR
OTHER LEGAL OR EQUITABLE THEORY, INCLUDING A BREACH OF A CONDITION OR
FUNDAMENTAL TERM OR FUNDAMENTAL BREACH OR BREACHES. THE LIMITATIONS
SHALL NOT APPLY TO CLAIMS FOR PERSONAL INJURY OR BODILY HARM CAUSED BY
EITHER PARTY, OR PAYMENT OF AMOUNTS OWING BY THE END USER TO IPANEMA OR
ITS RESELLER.

3. 7. GOVERNING LAW
This License is governed by French law and any proceedings arising out of or in connection with
this License shall be submitted to the Commercial Court of Paris, France.
If any provision hereof is held invalid, the remainder shall continue in full force and effect.

February 2012

Ipanema Technologies

3-3

CHAPTER 4. TECHNICAL SUPPORT


Document organization

4. 1. CUSTOMER TECHNICAL SUPPORT


Do not attempt to repair the equipment yourself. Do not remove ip|engine covers
and casings. This will void any warranty.

Please refer to the support and maintenance contract for specific information about these services.
Should you have any problem with your system, please contact your supplier for technical
assistance.
In any case, you can get support and information by logging on Ipanemas Support web site:
https://support.ipanematech.com,
where you can access the Public Knowledge Database, find Technical notes and FAQs, be informed
of the latest developments and updates, download all the Ipanema software, create and track
tickets, and find other relevant information relating to the Ipanema System.
An account will be created on demand.
Other contact information:
E-mail: support@ipanematech.com
Phone: +(33)1 55 52 15 22
Fax: +(33)1 55 52 15 01
In the event of a technical problem, please supply as much information as possible, in particular:

your name, address, telephone number and the name of your company,
your Ipanema Technologies license number, see window about in ip|boss field reference,
the names, versions and serial numbers of the products you are using,
the version: Windows (2000 / 2003) or Solaris of operating system for ip|boss,
a description of the installed configuration and the configuration files,
a detailed description of the problem you have encountered.

February 2012

Ipanema Technologies

4-1