Using SetupDB.exe

 

 

Author:              Lance Darwent

Date:                  October 2009

Revised:            October 2009

Audience:         IT

Summary:         Using the SetupDB application to attach a LegalSuite backup file to the SQL Server.

 

CONTENTS:

 

·         Introduction

·         Step 1: Ensuring that you have the correct version of SetupDB.exe

·         Step 2: Logging in to the SQL Server

·         Step 3: Selecting the correct backup file

·         Step 4: Determining the Database Name, User Name and Password to use

·         Step 5: The Database attachment process

·         Step 6: Explaining the SQL String in the LegalSuite Shortcut Properties

·         Appendix A: Downloading the new SetupDB Application

 

Introduction:

 

SetupDB is an application developed by LegalSuite to make it easier when attaching the LegalSuite database

onto a new/current installation of Microsoft SQL Server


Step 1: Ensuring that you have the correct version of SetupDB.exe

 

 

SetupDB.exe can be found in the %ROOT%\Lsuite\lsw\setup directory, typically this will be installed on the

LegalSuite server’s C: drive

 

It is very important that you have the correct version of LegalSuite’s SetupDB application; this can be identified

by ensuring that the two fields, namely the “User” and “Password” fields exist, as illustrated below:

 

 

If your version of SetupDB.exe doesn’t look like the one above, please download the latest version

from: ftp://ftp.legalsuite.co.za

 

When prompted for a username and password, please contact the LegalSuite offices and request a

username and password (the details provided will allow you access to retrieve the “new” version)


 

Once logged-in, navigate to the “Apps” folder and locate the Setupdb.exe.

 

 

 

Please download this application (for details of how to “download” this file please see appendix A.)

Once you have successfully downloaded this file save it to the %ROOT%\Lsuite\lsw\setup directory.


Step 2: Logging in to the SQL Server

 

 

When you run the Setupdb application, you will be prompted for the SQL Server login credentials as

shown below:

 

 

2.1       Please fill in the Server name including the instance name of your SQL Server. If you are unsure

of what it is, you can select the correct SQL Server from the drop-down list.

 

2.2       Please remove the tick from the check box labelled “Use Trusted Connection” as this logs in to

the SQL Server using Windows Authentication which is not recommend when installing the LegalSuite database.

 

 

2.3       Insert ‘sa’ as your Login ID

 

2.4       Insert the password that was created for the ‘sa’ login – this would have been done by the individual that installed

the Microsoft SQL Server (typically this password is BLANK).

 

2.5       Once all of the login credentials have been filled in and are correct, click on “OK”

 


2.6       Once the SQL Server verifies the supplied login details are correct it will allow you access to the SetupDB Interface

with the fields pre-filled as shown below:

 


Step 3: Selecting the correct backup file

 

3.1       It is important that you use the correct database backup file when using SetupDB as this is the LegalSuite

database containing all of the LegalSuite information.

 

 

3.2       SetupDB will by default use the backup that is shipped with LegalSuite, this is our sample database and does not

contain any data.

 

If you are using SetupDB to restore a backup then please click on the browse button and select the correct backup file.


3.3       Once you have located and selected the correct LegalSuite backup file, click on the “Open” button as illustrated below:

 


 

This will take you back to the main SetupDB interface with the appended path to the LegalSuite backup as shown below:

 

 


Step 4: Determining the Database Name, User Name and Password to use

 

            Please Note:

·         If there is an existing version of LegalSuite (database) installed on this instance of the SQL Server, installing a new

version with the same name will overwrite the existing database.

·         If the “User” field is the same as an exisiting user of a LegalSuite database then this will conflict with the existing

LegalSuite.

·         Microsoft SQL Server 2005 and later require a “Strong Password”, this means that you will need to use an

alphanumeric password, IE: ls123 or lsw123

 

 

4.1       Once you have determined which database name, User and Password to use, you can insert them into the relevant

fields within the SetupDB interface as illustrated below:

 

 

Please ensure that you remember what the User Name and Password is as it will be needed in order to setup the LegalSuite

shortcut correctly.

 

Once you are certain that neither the “Database” or “User” fields are the same as an existing Database, you can click on

the “Install Database” button.

 

If you are attaching the LegalSuite database to a new installation of SQL Server, we recommend that you use the SetupDB’s

default values – this will assist the LegalSuite support staff with trouble-shooting connection problems.


Step 5: The Database attachment process

 

Once you have clicked on the “Install Database” button, the below confirmation box will appear:

 

 

5.1       If you are happy with the database name and path of where it will be installed then click on “Ok”, this will display the

progress information box as shown below:

 

 

No user interaction is required at this point.


 

Once the Installation has been completed the information box will display this as shown below:

 

 

Please note that this installation process may take several minutes depending on the size of the database, it may appear to not

be doing anything but it is important that it is not interrupted while installing the database.

 

5.2       Click on the “Close” button to exit the information box.

 

The database has now been installed to the selected SQL Server instance and is ready to be used.


Step 6: Explaining the SQL String in the LegalSuite Shortcut Properties

 

The LegalSuite application requires that the database login details be saved in the shortcut to eliminate the need for the user to

login to the SQL Server before accessing LegalSuite – this is done in the form of a SQL string parameter which is passed in the

target line of the LegalSuite shortcut as illustrated below:

 

 

The SQL string needs to be inserted into the target line after the lsw.exe location and is enclosed by double quotation marks (“)

 

This SQL string is broken down as follows: “sqllogin=’ServerName’\’InstanceName’,,’User’,’Password’”

 

Please see below for an accurate representation of the entire target of the LegalSuite shortcut

 

“Target” - C:\Lsuite\lsw\lsw.exe "sqllogin=lanced\server2008,,ls123,password123"

 

The ‘User’ and ‘Password’ fields are taken from the database installation process done in Step 4.

 

The LegalSuite database installation process is now complete.

 


Appendix A: Downloading the new SetupDB Application

 

1.            Once you have gained access to the FTP Server using the login credentials supplied by the LegalSuite support staff, navigate

         to the “Apps” folder.

 

2       Right-Click on the setupdb.exe and select “Copy to folder” as shown below:

 

 

This will open the “Browse for Folder” window.


3.            Please browse to: %ROOT%\Lsuite\lsw\setup and select “OK”

 

 

If you are asked if you would like to overwrite the existing file, select “Yes”.