STORMWATER & WASTEWATER MANAGEMENT MODEL
INSTALLATION MANUAL
Copyright
© 2014 XP Solutions. All rights reserved. No part of this publication may be reproduced in any form by
any means without the written permission of XP Solutions. XP-SWMM and xpswmm are trademarks of
XP Solutions. Other brand and product names are trademarks or registered trademarks of their
respective holders.
Software License Notice
Your License Agreement, which is included with this product, specifies the permitted and prohibited uses
of the product. Any unauthorized duplication or use of xpswmm in whole or in part, in print or in any
other storage and retrieval system is forbidden.
Disclaimer
The XP environment and its documentation have been released by XP Solutions as a proprietary model
and as such are not available to unauthorized users.
The authors and XP Solutions, although taking every care to provide error free code, because of the
complexity and nature of this type of software, cannot make explicit warranties as to the documentation,
function, or performance of the model. Should any errors be found during program operation the user
should direct the problem to XP Solutions where every effort will be made to quickly resolve the problem.
Although the data checking facilities of the model are extensive, incorrect results may be produced if
poor or inappropriate data are entered.
Users are expected to make the final evaluation as to the usefulness of the model for their purposes. He
or she must use his or her own engineering judgment as to the applicability of the model to the job at
hand and perform reasonable engineering checks on the data and results. XP Solutions cannot assume
responsibility for model output, interpretation or usage.
No portion of this document may be reproduced in any form without the express written consent of XP
Solutions.
Table of Contents
Installation Guide
Section 1: Introduction
Section 2: Installing xpswmm
2.1 Launching the Installer
2.2 Standalone Version Installation Instructions
2.3 Network Server Installation Instructions
2.4 Network Client Installation Instructions
2.5 Evaluation Version Installation Instructions
Section 3: Uninstalling xpswmm
Section 4: Troubleshooting Your Installation
Section 5: Release Notes
5.1 Operating System Requirements
5.2 Installation Type
Section 6: Silent Installation
Getting Started
XP Solutions
Version 2014
2 – Installing xpswmm
1. Installation Guide Introduction
Welcome to XP Solutions’s xpswmm stormwater and wastewater decision support system.
xpswmm is a link-node model that performs hydrologic, hydraulic and quality analysis of
stormwater and wastewater drainage systems including sewage treatment plants, water quality
control devices and Best Management Practices (BMP’s). This software package utilizes
sophisticated graphical tools together with associated Geographical Information Systems and
CAD. xpswmm is a full 32 bit software package for Windows XP, Vista, 7 (32 and 64 bits), 8 as
well as Windows 2008, 2008 R2, 2012, and 2012 R2 for the server versions.
xpswmm may be used to model the full hydrologic cycle from stormwater and wastewater flow
and pollutant generation to simulation of the hydraulics in any combined system of open and/or
closed conduits with any boundary conditions.
This manual details the installation of xpswmm. If you follow all steps outlined in the following
pages you will have a successful installation. If you have any problems throughout the course of
your installation please consult the Troubleshooting Section (Section 4) in this manual or
contact XP Solutions Technical Support.
To maximize your investment, XP Solutions would encourage your participation at one of their
regular detailed training workshops. The schedule for public workshops can be found at
www.xpsolutions.com.
The tutorials that follow the introductory and installation sections will provide you a basic
introduction to modelling applications of xpswmm The set of tutorials will also act as an
overview to most of the model building and results presentation tools. The graphic images and
the text instructions have been based on installing xpswmm in the default folder C:\Program
Files (x86)\XP Solutions\xpswmm2014. This root of the installation may be different in your case
and therefore you should make any necessary adjustments when searching for files to complete
the tutorials.
Regardless of the selected root folder the templates, work, and samples folder will be located
from the main xpswmm folder.
Page 1
Page 2
Section 1: Installation Guide Introduction
2. Installing xpswmm
2.1.
Launching the Installer
xpswmm is available on DVD-ROM or as a Web download.
You must be logged in, on Windows XP, Vista , Windows 7 or 8 with Administrator privileges.
When you insert the DVD it should automatically launch the following screen.
If this does not occur, access the screen by running Start_xpswmm.exe from the DVD.
Select the Install Software option on the menu.
Page 3
2.2 Standalone Version Installation
On the main screen, click on Install.
After selecting the Install button you may be prompted by Windows User Account Control to
allow the installer to proceed. Click on Yes.
Page 4
Section 1: Installation Guide Introduction
The installer will then extract and install various prerequisites.
Select Next to start the xpswmm 2014 installation process.
Page 5
Review the License Agreement and select the checkbox to accept the terms and activate the
Next button. Click on Next.
Select the Standalone version option. Click on Next.
Page 6
Section 1: Installation Guide Introduction
By default all documentation will be installed in C:\Program Files (x86)\XP Solutions\
xpswmm2014\. However, you can change the folder by selecting the “Change” button.
The shortcuts to the desktop and the start menu will be also added by default; but you can
customize them by unselecting the options.
Browse to the folder where the program will be installed. Click on Next.
Page 7
Browse to the location of your configuration file, xpswmm.xcf. It is found on the DVD when you
purchased xpswmm or attached to an email if you purchased an upgrade. Click on Select.
Click on Next to continue.
Click on Install to complete the installation.
Page 8
Section 1: Installation Guide Introduction
When the installation is completed, click on Finish.
The final dialog indicates that xpswmm has been installed. Click on Close.
Page 9
2.3 Network Server Installation
On the main screen, click on Install.
After selecting the Install button you may be prompted by Windows User Account Control to
allow the installer to proceed. Click on Yes.
Page 10
Section 1: Installation Guide Introduction
The installer will then extract and install various prerequisites.
Select Next to start the xpswmm 2014 installation process.
Page 11
Review the License Agreement and select the checkbox to accept the terms and activate the
Next button. Click on Next.
Select the Network Server (Network dongle drivers required) version option. Click on Next.
Page 12
Section 1: Installation Guide Introduction
The Destination Folder is used to install a copy of XPDiagnostic.exe. Click on Next.
Click on Install to complete the installation.
Page 13
When the installation is completed, click on Finish.
The final dialog indicates that xpswmm has been installed. Click on Close.
Page 14
Section 1: Installation Guide Introduction
2.4 Network Client Installation
On the main screen, click on Install.
After selecting the Install button you may be prompted by Windows User Account Control to
allow the installer to proceed. Click on Yes.
Page 15
The installer will then extract and install various prerequisites.
Select Next to start the xpswmm 2014 installation process.
Page 16
Section 1: Installation Guide Introduction
Review the License Agreement and select the checkbox to accept the terms and activate the
Next button. Click on Next.
Select the Network Client version option. Click on Next.
Page 17
By default all the documentation will be installed in C:\Program Files (x86)\XP
Solutions\xpswmm2014\; however, you can change the folder by selecting the “Change” button.
The shortcuts to the desktop and the start menu will be also added by default; but you can
customize them by unselecting the options.
Browse to the folder where the program will be installed. Click on Next.
Page 18
Section 1: Installation Guide Introduction
Browse to the location of your configuration file, xpswmm.xcf. It is found on the DVD when you
purchased xpswmm or attached to an email if you purchased an upgrade. Click on Select.
Click on Next to continue.
Type the IP address of the server where the dongle is plug in. Click Next.
Page 19
Click on Install to complete the installation.
When the installation is completed, click on Finish.
Page 20
Section 1: Installation Guide Introduction
The final dialog indicates that xpswmm has been installed. Click on Close.
Page 21
2.5 Evaluation Version Installation
On the main screen, click on Install.
After selecting the Install button you may be prompted by Windows User Account Control to
allow the installer to proceed. Click on Yes.
Page 22
Section 1: Installation Guide Introduction
The installer will then extract and install various prerequisites.
Select Next to start the xpswmm 2014 installation process.
Page 23
Review the License Agreement and select the checkbox to accept the terms and activate the
Next button. Click on Next.
Select the Evaluation version option. Click on Next.
Page 24
Section 1: Installation Guide Introduction
By default all the documentation will be installed in C:\Program Files (x86)\XP
Solutions\xpswmm2014\; however, you can change the folder by selecting the “Change” button.
The shortcuts to the desktop and the start menu will be also added by default; but you can
customize them by unselecting the options.
Browse to the folder where the program will be installed. Click on Next.
Page 25
Click on Install to complete the installation.
When the installation is completed, click on Finish.
Page 26
Section 1: Installation Guide Introduction
The final dialog indicates that xpswmm has been installed. Click on Close.
Page 27
3. Uninstalling xpswmm
Open Control Panel and choose Add/Remove Programs. Select the Change/Remove button for xpswmm. Click
on Uninstall.
On the Wizard dialog, select Uninstall.
Page 28
Section 1: Installation Guide Introduction
Click on Close.
Page 29
4. Troubleshooting Your Installation
Error 3: Dongle not found.
Solution 1: The license configuration file was not found in the xpswmm directory or is read only.
Find the xpswmm.xcf file with the correct version number for the version of xpswmm that you
are installing. The file may have been attached to an e-mail from XP Solutions announcing your
product eligibility or can be found on the root directory of the installation DVD.
Copy and paste the file into your xpswmm directory.
It is important to mention that in previous versions of xpswmm, the configuration file had the
extension *.cnf.
Solution 2: The license configuration file in the xpswmm directory is read only. Check the
properties of the file and make it read/write.
Solution 3: The license configuration file does not have the correct license number for the
Sentinel hard lock that you are using. The numbers coded on the hard lock and in the license file
must match.
1. Run the program XPDIAGNOSTIC.EXE found in the xpswmm directory to read the
number coded on both the hard lock and the license file.
2. Find and install a matching pair of hard lock and license files.
3. Copy and paste the file into your xpswmm directory or re-install the application.
Page 30
Section 1: Installation Guide Introduction
Error 70/74: Internal error.
Problem: Internal LAN/WAN communication between client and server is interrupted.
Solution: Check with your system administrator or re-install the application making sure that the
license file and the hard lock have matching coded numbers.
Run the program
XPDIAGNOSTIC.EXE found in the xpswmm directory to read the number coded on both the
hard lock and the license file. If XPDIAGNOSTIC.EXE cannot read the hard lock, the hard lock
may need to be replaced. Contact XP Solutions technical support.
Page 31
Try to install xpswmm again with the log activated
1. Open the command line (Start->Run, type cmd, click OK)
2. Install xpswmm by typing one of the following lines
xpswmm2014.exe /L "d:\mylog.log"
xpswmm2014.exe /log d:/mylog.log
3. Please send us by e-mail the file generated in the installation if you still face the
problem.
Error uninstalling xpswmm
Problem. The XP Products register some components in the Windows Registry Editor, therefore,
if you remove some files without removing them also from the registry or if you do not uninstall
the product properly; there will be a mismatch between the files in the registry and the system.
Solution1. Run the msicuu.exe tool attached in the \Disc Image\Resources\technical support
folder to make sure that the software will be completely deleted from your system. This
program usually forces the software to uninstall and removes all registries.
Run msicuu.exe with Administrator permission, select xpswmm 2014 from the list display and
click on the Uninstall button.
Solution 2. Open the \Disc Image\Resources\technical support \remove-registry-xpswmm2014.reg
file; run it with administrator permissions and then try to reinstall xpswmm 2014.
For the Sentinel drivers, we usually ask the client to install the SSD Cleanup utility from this link
http://www.safenet-inc.com/support-downloads/sentinel-drivers/
Page 32
Section 1: Installation Guide Introduction
5.
xpswmm Release Notes
5.1 Operating System Requirements
This installer for xpswmm 2014 will run on:
•
•
•
•
Windows XP
Windows Vista
Windows 7
Windows 8
All of the above operating systems are compatible in both 32 and 64 bits.
5.2 Installation Type
xpswmm is available in three installations:
•
Standalone - requires Sentinal lock and client specific configuration file.
•
Network - requires Sentinal lock and client specific configuration file.
•
Evaluation/Demo - Software Protection - 30 day ready to try license, starts in demo
mode and can be upgraded with electronic key to and evaluation configuration of 5
nodes, key printing, export, and saving disabled in demo but saving and printing
available in the evaluation.
Note: Please report any problems to [email protected]
Page 33
6. xpswmm silent installation
The commands available for xpswmm 2014 on the command line could be displayed by typing:
xpswmm2014.exe /?
For example:
/i. Install the product.
/q. Quiet install (no UI).
The following can be specified from the command line:
•SetupType. (Required)
Must be one of: Standalone, NetworkClient, NetworkServer, Evaluation
•ApplicationFolder. (Optional)
The folder in which the application will be installed to. If not set, it will install to the default location (e.g.
C:\Program Files (x86)\XP Solutions\xpswmm2014).
Page 34
Section 1: Installation Guide Introduction
•LicenseFile. (Required for Standalone and Network Client setup types.)
The path to the xcf license configuration file.
•ServerAddress. (Required for NetworkClient)
The IP address of the server that has Sentinel network dongle.
Examples of using the installer from the command line:
Standalone (Sentinel):
xpswmm2014.exe /i /q SetupType=Standalone ApplicationFolder=C:\XPS\xpswmm2014
LicenseFile=D:\xpswmm.xcf
Network Client:
xpswmm2014.exe /i /q SetupType=NetworkClient ApplicationFolder=C:\XPS\xpswmm2014
LicenseFile=D:\xpswmm.xcf ServerAddress=192.168.1.1
Network Server:
xpswmm2014.exe /i /q SetupType=NetworkServer ApplicationFolder=C:\XPS\xpswmm2014
Evaluation:
xpswmm2014.exe /i /q SetupType=Evaluation ApplicationFolder=C:\XPS\xpswmm2014
Page 35
Page 36