Running the Installer - CMSi Documentation

CMSi Installer

BEFORE YOU START
Clean Install vs Upgrade
Running the CMSi Installer
Select Installation Folder
Choose Components to Install
Select Database Parameters
Finish
Repair and Uninstall CMSi
Possible Manual Changes

1. Before you start

Checklist: before you begin you MUST have:

SQL Server Database - For a new CMSi installation, make sure you have installed SQL Server 2014 or higher and SQL Studio Management Services (SSMS).
SQL Server database sysadmin account - You will need to know the user name and password of a SQL Login on your SQL Server instance that has sysadmin privileges, eg. the sa account. You can use a Windows account if that has full Administrator permission. (If you are unsure then open the Properties of the SQL Login account and look for a tick beside 'sysadmin' in the 'Server Roles page).
Database backup - Before upgrading an existing installation, make a backup your CMSi database. This can be done from the Tools menu in CMSi, or directly from the database e.g. from within SQL Server Management Studio. This is preferable to relying on a full server backup since it is much easier to restore a single database than fetch files from a server backup.
Application backup - Before upgrading an existing installation, make a backup copy of your CMSi application folder. This will ensure that any local settings and configuration can be checked against upgraded files.
No one using CMSi - Make sure that you have exited from CMSi and that no other CMSi users are logged on when you run the installer.

1. Clean Install vs Upgrade

In most instances we will be upgrading an existing Client installation. This would assume that the client would have an existing database, and possible tutorial database, on a local installation e.g. desktop pc or laptop or an accessible server, and a Client Interface component on each of the users computers, or via an RDP (Remote Desktop Protocol) connection to a central server.

For a new Client we would be installing a complete, clean installation. This would build a new database, and client interface, but assumes that the client will have an accessible SQL Server database for the installation.

The installer will examine the Windows Registry for any previous installations of the software and will assume that it will be Upgrading an existing installation if it detects the software. If you wish to perform a Clean installation over a previous version, then you will have to uninstall CMSi first.

If you are wanting to set up a second parallel installation on the same server e.g. a test environment, you will have to do this manually. Please contact the CMSi Product team for advice as there are a number of decisions to be made regarding this.

2. Running the CMSi Installer

The CMSi installer requires full admin rights on the PC or server where it is being run. You must ensure that the user logged onto the computer has sufficient administrator privileges to install software and the correct rights on the SQL Server.

The installer can run the upgrade of the database component separately to the upgrade of the interface component, or both can be run at the same time (only recommended for a Clean Installation).

You would need to run the database component first once and then run the installer again, on each computer where CMSi is installed, to upgrade the interface component.
The upgrade of the database component can be run from any CMSi client computer.

To start the installer, double-click on the file called Setup.exe (if you have admin rights, or Right-click and "Run as Administrator".

Click Next at the welcome screen.

3. Select Installation Folder

Enter or browse to the folder where CMSi is installed.

The installer will create the CMSi software installation and will write log files into a \Installation_Date folder in this location.

Click Next.

4. Choose Components to Install

At this stage it is possible to select which components to install.

It is possible to Select the Database and Client components at the same time, which is often the case for a Clean installation, but generally we upgrade one component at a time, the Database first, and then re-run the software and then the Client component.

The Actions Service may be utilised by those clients with the PAM module, and should only be installed after consulting with the CMSi Product team.

Further information may be found on in the CMSi Documentation pages on the Actions Service page

(Note: The Actions Service MUST be switched off prior to installation)

5. Select Database Parameters

The following screen sets out the parameters that connect the software to the database.

SQL Server Instance:

The installer will detect any instances it can find and list them in the dropdown. If your instance is not in the list you can type the correct server name\instance name into the field. (You may need to do this if the server is on another part of your network).

To find the correct instance name, look in the cmsi-mdi.exe.config file in your CMSi application folder.

Open this file in Notepad and look for the following line near the top of the file; the part in bold is the SQL instance name:

add name="CMSI" connectionString="Data Source=Win7VM\CMSI_SQLEXPRESS;Initial Catalog=cmsi-full;User ID=cmsi;Password=cmsi;"

Authentication:

You will also need to provide a login with system admin rights on that server:

if you choose Windows Authentication, it will use the currently user logged on to the computer;
if you choose SQL Authentication, you must enter an SQL login and password with system administrator privileges.

User parameters:

This requires the login used by CMSi to connect the database – as shown in bold in the following extract from the CMSI-MDI.exe.config file.

User ID=cmsi;Password=cmsi

Select Databases:

You need to select the database name for the CMSi database and the Tutorial database - existing databases for this SQL server instance are listed in the drop-down boxes.

If you are creating a Clean installation, or adding in a new Tutorial version of the database, you can type in the name of the database you wish to create.

Click Next.

You then have a review page where you can check your selected components and parameters.

It is possible to click Back at this stage to amend any details.

6. Finish

Clicking Install will start the installation process running (you may see one or more Command Prompt dialogue boxes open)

and progress will be shown. Once the process has finished you should see the Successful Installation Complete page.

7. Repair and Uninstall CMSi

If you have a previous installation set to the current version of CMSi and then run the installer you will see a different Welcome page, where you have a choice to either Repair the current installation (this restores all of the components back to their default values) or to Uninstall CMSi from your system.

8. Possible Manual Changes

Map files: in the ~cmsi\map folder

The “Map” files may need to be manually amended, this might be because you have bespoke Organisational settings (such as the path to your MapLink document, if you use MapLink, or the use of group layers; if you have translated your mapping layers, if you have made some changes to the style of your CMSi layers i.e the appearance of the Sites, Compartments, Features, Projects or Annual Projects layers), or there have been updates to these files as part of the upgrade of the software.

If you think this might be the case, then please send a zip file of your Map folder to the CMSi Product team and we will send you an upgraded version that contains your changes, prior to the Upgrade, or ensure that you have a Backup of your original CMSi files so that these files can be edited at the time of upgrade.

Report Library: in the ~cmsi\ReportLibrary folder

There may have been updates to the Master Report libraries - amended reports and additional reports created etc. and the Filtered and Standalone report Libraries may need to be updated. However you may have bespoke organisational reports and these will have to be retained and copied across to the upgraded folders

Find out more