Volcano 3.1.

1
Installation Guide

Copyright
2001-2010 SIRADEL SAS. All rights reserved. Volcano 3.1.1 Installation Guide Atoll 2.x/3.1 Edition This manual, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. The content of this manual is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by SIRADEL SAS. SIRADEL SAS assumes no responsibility or liability for any errors or inaccuracies that may appear in this documentation. Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of SIRADEL SAS. First edition: January 2010 Last edition: January 2012 France Headquarters SIRADEL S.A.S. 3, alle Adolphe Bobierre CS 24343 35043 RENNES Cedex FRANCE Tel: +33 (0) 2 23 480 500 Fax:+33 (0) 2 23 480 599 Hong Kong, China, Asian Office SIRADEL Asia Suite 2909-10, 29/F, China Resources Building N26 Harbour Road, Wanchai Hong Kong Toronto, Canada, American Office Wireless Expertise and Research Centre Suite 200 1920 Yonge Street Toronto ON M4S 3E2 Tel: +1 416 572 7678 Fax: +1 416 572 7501

Siradel copyright 2012. All rights reserved.

Page 2

Content
1. Volcano Software Installation ..................................................................................................... 4 1.1. Installation Requirements ........................................................................................................ 4 1.2. Step by Step Installation .......................................................................................................... 5 1.3. Installed Files ........................................................................................................................ 11 1.4. Volcano Software Uninstallation ............................................................................................ 12 2. Volcano License Installation ..................................................................................................... 14 2.1. Introduction............................................................................................................................ 14 2.2. Collecting Required Information............................................................................................. 14 2.3. Licensing Tools Installation .................................................................................................... 16 2.4. License File Installation ......................................................................................................... 17 2.5. License Update ..................................................................................................................... 20 3. Volcano initialization parameters ............................................................................................. 22 3.1. Volcano log level ................................................................................................................... 22 3.2. Volcano Multi-process ........................................................................................................... 22 3.3. User Access Functionality ..................................................................................................... 23 3.4. Temporary and log folders customization .............................................................................. 27 4. Technical Support...................................................................................................................... 29

Siradel copyright 2012. All rights reserved.

Page 3

1. Volcano Software Installation

This section describes the entire process to install Volcano software as well as the modifications performed on your system.

1.1. Installation Requirements

100 MB of free disk space Account with administrator privileges (belonging to the Administrator Group) .NET Framework 3.5 SP1 must be installed (will be installed by the setup if not detected) Windows Seven users must also set User Access Control to the lowest security level: o Go to Control Panel > User Accounts > User Accounts > User Accounts Control Settings o Decrease notification level to the min (Never notify, as shown in Figure 1) o Modification will be effective after rebooting the workstation

Figure 1: User Account Control setting adjustment under Windows 7

For the Volcano installation, the decimal separator must be set to dot (.), not coma (,) o Go to Control Panel > Region and Language > Formats > Additional settings... o In Numbers tab, choose dot (.) as decimal symbol (see Figure 2)

Siradel copyright 2012. All rights reserved.

Page 4

Figure 2: Set dot (.) as decimal separator

1.2. Step by Step Installation

1.2.1. Installation Start-up

The user must run the Volcano installation set up to start the installation procedure (available on the SIRADELs website or provided by the Volcano support team). The installer window will pop-up with a welcoming message. Click on the Next button.

Siradel copyright 2012. All rights reserved.

Page 5

Figure 3: First Volcano installation window

In the next step, the user is asked to accept the license agreement. Accept the agreement and click on the Next button to continue the installation.

Figure 4: License approval

Siradel copyright 2012. All rights reserved.

Page 6

1.2.2.

Installation Directory

The following window gives the possibility to the user to modify the directory where Volcano is installed (refer to Figure 5). It does not have to be an existing directory since the installer will create it. A directory name is suggested but can be modified by pressing the Browse button, and thus selecting a directory through a standard GUI. Click on the Next button to continue the installation.

Figure 5: Selection of the destination path

The next window lets the user choose the kind of installation by selecting the components to be installed. Once all components needed have been checked, click on the Next button to continue the installation.

Siradel copyright 2012. All rights reserved.

Page 7

Figure 6: Selection of the Volcano components

The features to be installed on the users machine are then summarized. Click on the Install button to start the installation.

Figure 7: Summary of features to install

Siradel copyright 2012. All rights reserved.

Page 8

Setup first checks whether .NET Framework 3.5 SP1 is already installed on the workstation. If the dependency is not detected, a specific setup wizard is launched and user needs to accept the terms of license agreement before starting the installation.

Figure 8: Microsoft .NET Framework 3.5 SP1 setup

Clicking Install will trigger .NET Framework installation, which may take several minutes. .NET framework dependency needs to be downloaded from Microsoft web site thus requires the workstation to be connected to the Internet during the installation. If the dependency cannot be downloaded the installation of .NET Framework software will fail and Volcano installation will go on. In this case, user will have to install manually .NET Framework 3.5 SP1 software after Volcano installation has completed. After optional .NET Framework installation, Volcano set-up is performed and a status bar shows the progress (refer to Figure 9).

Siradel copyright 2012. All rights reserved.

Page 9

Figure 9: Installing...

1.2.3.

End of Installation

The next window informs (Figure 10) the user about main steps to carry out in order to install Volcano licenses. Click on the button Next to continue the installation.

Figure 10: Volcano license information Siradel copyright 2012. All rights reserved. Page 10

The last window (Figure 11) simply informs the user about the status of the installation procedure. Click on the button Finish to complete the installation.

Figure 11: Installation completed

1.3. Installed Files

Once the installation has been successfully performed, the different directories are installed in the path you previously chose. The functionality of the different directories installed on your machine is described in the figure below.

Siradel copyright 2012. All rights reserved.

Page 11

Volcano DLL files Volcano configuration files

Volcano documentation Volcano log files Dotnet interface resources Temporary computation files

Figure 12: Installed directories

1.4. Volcano Software Uninstallation

To uninstall Volcano, go on Add/remove programs in the configuration panel. Select the application Volcano for Atoll and click on Remove (refer to Figure 13).

Figure 13: Volcano uninstallation

Siradel copyright 2012. All rights reserved.

Page 12

A pop-up window asks the user to confirm the removal of all Volcano components. Click on Yes to resume.

Figure 14: Warning window

When the process is completed, the following window appears. Click on OK to complete the uninstallation.

Figure 15: Uninstallation completed

Siradel copyright 2012. All rights reserved.

Page 13

2. Volcano License Installation

2.1. Introduction
Volcano requires a license file to be able to perform any operation. The license file is generated by SIRADELs software support team (support@siradel.com) with a code based either on the characteristics of the machine that will run Volcano or on the characteristics of one given hardware key (dongle). All the tools for the license management can be downloaded on our website www.siradel.com (in the tab Resources Tools). For requesting an access to the private area, please contact the SIRADEL Support team. NB: A dongle is a small piece of hardware that connects to a laptop or desktop computer via a USB port. Each dongle has its own hardware signature permitting to activate licenses.

2.2. Collecting Required Information

2.2.1. With a Dongle (hardware key + software key)

The license file is generated with the characteristics of the hardware key. In this configuration, there is nothing to do for the customer at this stage. SIRADEL provides customers with both hardware (dongle) and software keys (license file). NB: In this case, the Volcano application requires both hardware and software keys to run.

2.2.2.

Without Dongle (software key only)

The first step is to probe the system in order to collect the information necessary to generate a license file. With all this information, the license file will be generated for your own system. The license file is generated with the characteristics of the machine where the license will be installed. In order to probe the target machine, execute the file Wechoid located in Delivery\Admin.net\Win32 in the Sentinel licensing tools. In case the user wishes to install a standalone license or a license server on a desktop, you must check only one criterion, namely the Ethernet Address (the selector must be 0x10) and the Locking Data will appear automatically (refer to Figure 16).

Siradel copyright 2012. All rights reserved.

Page 14

Figure 16: Wechoid application for desktop

Otherwise, if the license is to be installed on a laptop, so the user can use the application even when disconnected from the network, you must check only the Disk ID criterion (Selector must be 0x4), and the Locking Data will appear automatically (refer Figure 17).

Siradel copyright 2012. All rights reserved.

Page 15

Figure 17: Wechoid application for laptop

Then, whatever the configuration of the installation (desktop or laptop), carefully write down the values of the Selector and Code, take a snapshot of the GUI and send an email to support@siradel.com containing this information. SIRADELs support team will generate a license file (software key) and send it back to you in the shortest term.

2.3. Licensing Tools Installation

2.3.1. License Server Installation

If the license provided is dedicated to a multi-user use (floating licenses), a license server has to be installed on the dedicated machine. Run the setup located in Delivery\Server\Setup in the Sentinel tools folder. The license server can be installed anywhere on the machine. NB: The license server does not need to be a real server but just need to be on the same network that all end-users.

2.3.2.

Dongle Driver Installation

If the license is provided with a dongle, the next step is to install the dongle driver. On the local machine, run the program Sentinel_Protection_Installer_X.X.exe available on SIRADELs private area (Section ResourcesToolsVolcano dongle driver). For this step, the dongle must not be attached to the computer.
Siradel copyright 2012. All rights reserved. Page 16

Then, attach the hardware key (dongle) to the USB port of the machine where you just installed the driver. In order to check that the dongle is well installed on your machine, you can run Wechoid (located in Delivery\Admin.net\Win32 in the Sentinel licensing tools folder) and check that the field Computer ID is not empty as displayed in the figure below. If this field is empty, it means that the dongle is not well installed or not connected.

Figure 18: Checking the dongle installation

2.4. License File Installation

2.4.1. Single User Local Installation (Standalone License)

Rename the license file into lservrc and copy this file into the directory where the program in charge of launching Volcano computations resides; such program will vary depending on whether multi-process feature is activated or deactivated (refer to section 3.2): By default multi-process is activated and the program executing a Volcano prediction is VolcanoAgent.exe: lservrc file must be located in folder <volcano Installation folder>\bin If multi-process is deactivated the program executing the Volcano stands for the RPT executable: lservrc file must be located in folder C:\Program Files\Forsk\Atoll NB: Do not forget to remove any file extension (the file must be named lservrc and not lservrc.txt).

Siradel copyright 2012. All rights reserved.

Page 17

For licenses based on a dongle characteristic, the software key can be used on another machine, but both dongle and software key (license file) have to be moved. For licenses based on the machine characteristic, the software key is associated to one given workstation and cannot be used on another machine.

2.4.2. 2.4.2.1.

Multi-user Network Installation (Floating License) Adding Licenses to a License Server

Use WlmAdmin utility (License Management Administrator) located in Delivery\Admin.net\Win32 to add licenses to a license server. This tool will permit you to install your license file as well as to manage your license pool. Select the server machine in the list and right click on it Select Add Feature From a File To Server and its File (see below) Browse and select the license file that you get from SIRADEL

Figure 19: Adding a new license file on a license server

Siradel copyright 2012. All rights reserved.

Page 18

NB: If it is the first token (floating license) added, then a file named lservrc is automatically created and is located in the Sentinel installation directory. Else, the new floating license(s) is (are) added to the existing ones in the lservrc file.

2.4.2.2.

Create an Environment Variable

In order to strengthen the research speed of the license, it is highly advised to create an environment variable on all the machines that will be using Volcano software. To create a new environment variable, go to System Advanced Environment Variables (this path can depend on the users Operating System). The environment variable will be called LSFORCEHOST (refer to Figure 20). The value can be either the server name or the IP server address.

Figure 20: LSFORCEHOST variable

It is recommended to create the variable as a System Variable.

Figure 21: Location of the environment variable

Siradel copyright 2012. All rights reserved.

Page 19

Thus, any client machine will easily find the license server. Indeed, before performing a broadcast on the whole network, it will look for a license server at the address specified by the LSFORCEHOST environment variable.

2.4.2.3.

Check the Floating License Installation

To check that the service of the license server is active and that the license file is saved, run the WlmAdmin application (subnet -> server name -> license name) as displayed in the figure below.

Figure 22: Displaying the installed licenses

2.5. License Update

2.5.1. Single User Local Installation (Standalone License)

The process to update a standalone license is similar to the standalone license file installation (see part 2.4.1). It has to be followed for both configurations: with and without a dongle. Rename the new license file lservrc and copy this file into the directory where the previous license file was. This previous license file will have to be deleted. Do not forget to remove any file extension (the file must be named lservrc and not lservrc.txt).
Siradel copyright 2012. All rights reserved. Page 20

2.5.2.

Multi-user Network Installation (Floating License)

The process to update a floating license is similar to the license file installation (see Figure 19). In WlmAdmin, the new license file must be added by right clicking on the right license server and pointing towards the new license file. The licenses are then automatically updated.

Siradel copyright 2012. All rights reserved.

Page 21

3. Volcano initialization parameters

Some features of Volcano software must be activated through the initialization file volcano_net.ini located in folder <Volcano_installation_folder>\bin. The sections below describe main Volcano features accessible through this file. Volcano_net.ini file will be read only at Radio Planning Tool launch, meaning any modification in this file will be considered after RPT restart only. Fields of volcano_net.ini file not described in the following sections should not be modified as such change may induce disturbances in Volcano behavior.

3.1. Volcano log level

Each Volcano computation will create a log file; location folder of these logs file can be customized as described in section 3.4. 3 levels of log can be set by specifying one of the following modes in LogLevel tag: nolog: no log file will be created normal: log files will contain a summary of prediction Tx and Rx parameters, license holding and computation countdown; this is the default log level verbose: this log level provided additional information such as propagation model and clutters parameters used for the computation; it should not be used unless Siradel support team requires it for advanced troubleshooting

Figure 23: log level field in volcano_net.ini file

3.2. Volcano Multi-process

Multi-process feature allows user to choose whether Volcano computations should be processed by the Radio Planning Tool process or by a specific Volcano Agent. Such setting has an impact on the amount of memory allocable to a Volcano prediction, thus on the maximum prediction radius a Volcano computation could handle: By setting MultiProcess to true, each Volcano computation will be performed by a dedicated Volcano Agent (default mode) By setting MultiProcess to false, all Volcano computations will be performed by the Radio Planning Tool Process (former mode)

Siradel copyright 2012. All rights reserved.

Page 22

Figure 24: Multi-process field in volcano_net.ini

Multi-process will suit to most of the prediction environments, especially when the Radio Planning Tool is running multiple threads: in this case each Volcano computation will be performed through a dedicated process, allowing high memory consumption for each Volcano computation and potentially improving prediction time. The only drawback of this mode is the small time overhead due to the creation of a Volcano Agent for each prediction, while the old mode will quickly sequence the predictions into Radio Planning Tool unique process; thus, user may deactivate multi-process feature for projects running small prediction radius.

Figure 25: Processes status with multi-process activated (left) or deactivated (right)

3.3. User Access Functionality

3.3.1. Introduction

The Volcano application offers an optional functionality to grant to end-users some rights on the Volcano models. 3 levels of access rights are available: Read/Write mode: user can create and customize Volcano propagation models and run predictions Read only mode: user can visualize Volcano models settings without modifying them and run predictions
Siradel copyright 2012. All rights reserved. Page 23

Hidden mode: user cannot visualize nor modify Volcano models settings but can run predictions

The identification of the user is based on Windows login, i.e. the session login. The user access configuration consists of 2 steps: Enable the user access functionality on each station/server running Atoll and Volcano software Create lists of users then assign them relevant rights

3.3.2.

User Access Functionality Activation

As the Volcano software is installed on a given station or server, the user access can be configured through the section <Services> of the configuration file Volcano_net.ini located in the Volcano installation folder (by default C:\Program Files\Siradel\Volcano_a\bin). See Figure 26 This file must be modified on each station featuring Atoll and Volcano software, and on which user rights configuration should apply.

Figure 26: Volcano User Access Configuration file - Volcano_net.ini

The section <Services> enables to: Activate or deactivate the user access functionality By default, the functionality is deactivated (active=false) and all users have full rights, i.e. both edition and modification of Volcano models in Atoll. Set active=true in order to activate the functionality for the users connected and using Volcano on the local station/server. Set the name and the path of the configuration file This configuration file (declared with tag <ConfigFile>) stores the user lists and related service levels. By default, the file is titled servicesconfig.xml and the path is in the local Volcano installation folder C:\Program Files\Siradel\Volcano_a\data\adaptor_data. It is recommended to set and update one unique configuration file, stored in one single location visible from all Atoll+Volcano stations and/or all Atoll+Volcano application servers. On each station or server, follow the steps: Edit the file Volcano_net.ini Activate the user access functionality Modify the path of the configuration file

3.3.3.

Volcano Users Access Rights Configuration

The configuration file can include one or various user lists and affect some rights to each user list defined in the servicesconfig.xml file located by default in C:\Program Files\Siradel\Volcano_a\data\adaptor_data
Siradel copyright 2012. All rights reserved. Page 24

Figure 27: Volcano User List & Services servicesconfig.xml

The current version offers 3 types of services (i.e. rights), as follows: readwrite: user has full rights on Volcano models, both edition and modification read: the user can display Volcano model properties but is not allowed modifying manually the parameters and settings or automatically while running a model calibration (all pages and parameters being grayed/disabled) hidden: the user cannot display nor modify Volcano settings (all tabs content are hidden), and is just allowed to run computations with Volcano models It is mandatory to set the list of users with full rights or read-only rights. All unregistered users will be granted by default with lowest rights level (equivalent to hidden). User should consider the following rules when editing servicesconfig.xml file: Username must the same as Windows login User denomination should contain domain\username or machine\username, not only username user and list fields are case sensitive

3.3.4.

Consequences on Model Edition

If the user has been granted with read/write rights, Volcano parameters and settings are enabled and can be modified manually or automatically through model calibration. All Volcano properties are enabled as illustrated in Figure 28.

Siradel copyright 2012. All rights reserved.

Page 25

Figure 28: GUI with full rights

If the user has been granted with read only rights, Volcano parameters and settings are disabled and cannot be modified manually or automatically through model calibration. All Volcano properties are disabled and greyed as illustrated in Figure 29.

Figure 29: GUI with read-only rights Siradel copyright 2012. All rights reserved. Page 26

If the user has been granted with hidden rights, Volcano parameters and settings are disabled and hidden. User cannot access any information about the model as illustrated in Figure 30.

Figure 30: GUI with hidden rights

In case Volcano User Access functionality is activated but the configuration file is not found (path is not correct), the following warning appears when opening project in Atoll and all users will be granted with lowest rights level (hidden mode).

Figure 31: Warning message if configuration file not found

3.4. Temporary and log folders customization

Volcano uses temporary and log folders to store information related to computations: temp directory consist in a folder where all temporary files related to Map Data handling will be stored log directory is the folder where Volcano logs are written for each computation By default these folders are located in Volcano installation folder, however in case Volcano user is not granted with writing rights on this location, computations will fail and generate errors. To avoid such issue temporary folders location can be changed to another location customized in volcano_net.ini file.
Siradel copyright 2012. All rights reserved. Page 27

Figure 32: temp and log directories in volcano_net.ini file

Siradel copyright 2012. All rights reserved.

Page 28

4. Technical Support
For technical support when you are installing Volcano, please contact the SIRADEL support team: e-mail: support@siradel.com telephone: +33 (0) 223 480 500 fax: +33 (0) 223 480 599

Siradel copyright 2012. All rights reserved.

Page 29