Installation Guidance Version 11.0

Transcription

1 Installation Guidance Version 11.0 December 2012

2 CONTENTS INSTALLATION OVERVIEW... 3 To test if installation is successful Setup configurations 4 Standalone installation... 4 Network installation... 5 Network installation, separate database and license server Installation of ShipWeight databases on the SQL Server 7 SQL Server software... 7 Database installation (Server installation) Installation of ShipWeight executable on client machine(s) Installation of the hardware lock 14 Install a client hardware lock (red lock) Install a network hardware lock (blue lock) Troubleshooting the hardware lock: Registration of ShipWeight users on the SQL Server 17 Set up users in a windows group Adding the user group to the SQL Server Adding the user group using the SQL Server 2005 Management Studio Setting up the user group with Sysadmin permissions Setting up the user group with minimum permissions Adding the user groups by commands Setting up the user group with Sysadmin permissions Setting up the user group with minimum permissions Enabling protocols for MSDE or Express Enabling protocols for MSDE Enabling TCP/IP protocols for SQL Express SQL Server Configuration Manager... 31

3 INSTALLATION OVERVIEW ShipWeight runs on Microsoft operating systems Windows XP, Windows Vista, Windows 7, Windows 2000 Server, Windows 2003 Server and Windows 2008 Server. The databases run on Microsoft SQL Server 2000/2005/2008 as well as the EXPRESS editions (including MSDE). Microsoft SQL Server needs to be installed on the network and set up properly before installation of ShipWeight. If a Microsoft SQL Server installation or license is not available, ShipWeight will run fine on the free versions of SQL Server, MSDE/MS SQL Server Express 2005/2008. See for download and installation instructions of the free SQL Server version. ShipWeight will run on 512 KB RAM, however, 1 GB or more is recommended, especially if working with large databases ( weight items or more). There are no other specific hardware requirements beyond what is required to run the operating systems and SQL Server. To make a complete ShipWeight installation, 4 tasks must be executed: 1. Installation of ShipWeight databases on the SQL server (server installation) 2. Installation of ShipWeight executables on client machine (client installation) 3. Installation of the hardware lock 4. Registration of ShipWeight users on the SQL server When installing ShipWeight the user must be logged on with administrator rights. TO TEST IF INSTALLATION IS SUCCESSFUL After installation, ShipWeight should be found on the Start menu of the operating system. Start ShipWeight in the ShipWeight login dialog, use the following: User name Password System Administrator admin ShipWeight In case of problems or questions, please contact: BAS Engineering AS office@bas.no Tel:

4 1. SETUP CONFIGURATIONS ShipWeight may be installed in the following configurations: Standalone installation Network installation network installation, separate database and license server This page and the following two pages will show how these three configurations should be set up. STANDALONE INSTALLATION In this case, everything is installed on the same computer so that ShipWeight may run outside a network. The following should then be executed: Installation of SQL Software (i.e. SQL Express 2005) See chapter 2 ShipWeight Databases Installation (Server installation) see chapter 2 ShipWeight Client Installation (Client installation) see chapter 3 Installation and attachment of hardware lock see chapter 4 Registering SQL users see chapter 5

5 NETWORK INSTALLATION In this case the ShipWeight executable is installed on client machines on a network, while the databases and the license lock are installed on a network server shared by the clients. This way all client machines log on to the same databases: ShipWeight Client Installation (Client installation) see chapter 3 Installation of SQL Software (i.e. SQL Express 2005) See chapter 2 ShipWeight Databases Installation (Server installation) see chapter 2 Installation and attachment of hardware lock see chapter 4 Registering SQL users see chapter 5

6 NETWORK INSTALLATION, SEPARATE DATABASE AND LICENSE SERVER This is the same configuration as the previously described network configuration, only in this case the license lock resides on a separate server. All client machines must have access to both servers in this case: ShipWeight Client Installation (Client installation) see chapter 3 Installation of SQL Software (i.e. SQL Express 2005) See chapter 2 ShipWeight Databases Installation (Server installation) see chapter 2 Registering SQL users see chapter 5 Installation and attachment of hardware lock see chapter 4

7 2. INSTALLATION OF SHIPWEIGHT DATABASES ON THE SQL SERVER SQL SERVER SOFTWARE Prior to installation of the ShipWeight databases, the server must have installed an instance of Microsoft SQL Server. If the number of users is less than 6, Microsoft s free SQL Desktop Engine (MSDE) or Microsoft SQL Express 2005 can be installed instead. See for download and installation instructions of the free SQL Server version. The SQL Server (or MSDE) must be set up using Windows Authentication for authorization of users. After an instance of SQL Server is present on the server, the ShipWeight databases can be installed. DATABASE INSTALLATION (SERVER INSTALLATION) To start installation of the ShipWeight databases, run Setup.exe in the Database Installation folder in the ShipWeight installation CD ROM. This should launch the following welcome dialog: Click Next

8 The next dialog shows the license agreement. Select the radiobutton I accept and click next Please click the Browse button to select the appropriate server to install ShipWeight database. If (local) shows up as your default server name, please still browse to select the server as (local) to our experience sometimes causes problems even if the SQL Server indeed is a local one. Select Windows authentication as connect option (default) and click next

9 Finally click Install button to execute the installation of the databases. If installation is successful at least the following databases should be present on the server: SWLogin ShipWeight user database sdb_shipddb Database for historical ship data wdb_<wbsname> Database for work breakdown structure (one or more)

10 3. INSTALLATION OF SHIPWEIGHT EXECUTABLE ON CLIENT MACHINE(S) To start installation of ShipWeight executables on the client machine(s), run Setup.exe from the Client Setup folder in the ShipWeight installation CD ROM. After some initial computer checking a welcome screen should pop up: Click next The license agreement is displayed. Select radio button I accept and click next

11 Next fill in user name and organization Click next Select folder to install the executables. Click Change button to select change the default location of the destination folder. Click next

12 Use Browse button to select the SQL Server containing the ShipWeight databases. Select connection using Windows authentication (default) and click next. For a normal installation, select Complete as setup type (default) and click next

13 Finally click Install to start executing the installation.

14 4. INSTALLATION OF THE HARDWARE LOCK For setup of a network hardware lock (blue lock), please see next page. INSTALL A CLIENT HARDWARE LOCK (RED LOCK) If ShipWeight is delivered with client hardware lock it is sufficient to plug in the hardware lock in an empty USB port on the client machine. This is all that should be needed for setup of a client lock. To check that the lock is working properly, ensure that the end of the lock is lit. If the lock is not lit this may indicate that the installation program was not able to install the drivers automatically. In this case, run the drivers manually after the installation. To do this, select the shortcut on the Start menu by clicking Start=>All Programs=>ShipWeight Enterprise=>Hardware lock=>setupdrv This will run the program Setupdrv.exe which is installed in the ShipWeight program folder. A successful run of this program should give a messagebox stating that the drivers are installed.

15 INSTALL A NETWORK HARDWARE LOCK (BLUE LOCK) 1. Install ShipWeight on all appropriate client machines. 2. The hardware net lock should be attached to a USB port on a server or other machine accessible from all client machines. 3. The files found in the Lock Driver folder on the ShipWeight installation CD ROM should be copied to a new empty folder on the server/machine containing the lock. This new folder will be the Lock System Folder. 4. All client machines will need full access permissions (read/write/create/delete) to the Lock System Folder. 5. Run SETUPDRV.EXE from the Lock System Folder (once). 6. DDNET.EXE should be run from the Lock System Folder each time the server is started. 7. The first time DDNET.EXE runs it will ask for a path. Give the path to the lock system folder. 8. Put DDNET.EXE in the Windows Startup group to ensure execution at startup. ( or run DDNET /S to run DDNET.EXE as service instead of as a program) 9. On all client machines, edit the SW.INI to be found in the Windows folder (Win 2000: Winnt folder) and make sure that the string DinkeyNetPath in SW.INI points to the Lock System Folder. You can use long filenames in the path if the machine is Windows 9x/Me/2000/XP, but for Windows NT you must use short filenames. Examples of the SW.INI file: If the server containing the Lock System Folder is mapped up on the client machine, the SW.INI could look like this: [dinkey] DinkeyNetPath=M:\LockSystemFolder If the server is not mapped, the SW.INI could look like this: [dinkey] DinkeyNetPath=\\SERVERNAME\LockSystemFolder The SERVERNAME represents the name of the server and the LockSystemFolder represent the name of the Lock System Folder.

16 TROUBLESHOOTING THE HARDWARE LOCK: In case you suspect the drivers to not work properly, try the following procedure: 1) Remove any dongles. 2) Run setupdrv /ufull 3) Reboot the machine. 4) Run setupdrv 5) Insert the dongle into the machine (for USB dongles, Windows should now install the drivers) 6) Reboot the machine. Check that the dongle end is lit Run the ddlook.exe file in the Lock System Folder and verify that the program finds the dongle and that SW is specified as the product code and that dd32.dll is listed as the protected program. On the server, open DDNET.INI file in the windows folder to check the registered path to the system folder (keyword fserver holds this path) and verify that the SW.INI file on the client machines points to the same folder. Make sure that the client machine got FULL access permission on the Lock System Folder. Make sure that the DDNET program is actually running, check Windows Task Manager. If the program returns an error code; try the support website of the dongle manufacturer (select Dinkey Dongle and Continue ).

17 5. REGISTRATION OF SHIPWEIGHT USERS ON THE SQL SERVER ShipWeight logs on to the SQL Server using Windows Authentication meaning the windows user is passed on from the client machine to the SQL Server. This document will describe the following: Set up users in a windows group Add this user group to the SQL Server o o Adding the user group through GUI Adding the user group through commands Check protocol enabling for the MSDE and SQL Express 2005 SET UP USERS IN A WINDOWS GROUP The following screenshots are taken from a Windows XP environment. Different operating systems may have different views. First, right click on the My Computer icon and select Manage to open up the console where the user group should be created. Figure 1: Open the Computer Management console

18 Next, in the console popping up, expand the Users and Groups folder, right click the subfolder called Groups and select New Group from the submenu. Figure 2: Select "New Group..." In the New Group dialog, give a name for the user group, in example ShipWeightUsers (and optionally a description for this group), then use the Add button to select the users which should belong to the group. In the Select Users dialog, use Advanced to get a dialog to search up right user names. See figure 3, 4 and 5 on the next pages.

19 Figure 3: The "New Group" dialog Figure 4: The "Select Users" dialog

20 Figure 5: Searching for users ("Advanced..." button) When you added the users to the New Group dialog, click the Create button in this dialog and you are done.

21 ADDING THE USER GROUP TO THE SQL SERVER ADDING THE USER GROUP USING THE SQL SERVER 2005 MANAGEMENT STUDIO Start Microsoft SQL Server Management Studio. Expand the SQL Instance and the Security folder so you can see the Logins folder. Right click the Logins folder and select New Login from the submenu. Figure 6: "Login New" dialog In the Login name editbox, write the complete domain name of the windows user group you want to give access to the ShipWeight databases. In this example, the domain name is RAA and the user group was called ShipWeightUsers, so the login name is RAA\ShipWeightUsers. You can use the Search button to find the user group, but remember to include Groups as an object you will be searching for by clicking the Object Types button in the Select User or Group dialog. See figure 7 and 8 on next page.

22 Figure 7: "Select User or Group" dialog Figure 8: "Object Types" dialog make sure to check Groups box Then back in the Select User or Group dialog, click the Advanced button to make a search for the user group. When the name of the user group is in place you are ready to map up permissions for the user group.

23 SETTING UP THE USER GROUP WITH SYSADMIN PERMISSIONS If the SQL Server instance is solely for the purpose of ShipWeight and it may be considered whether the user group can have a sysadmin server role. In this case, select Server Roles page in the dialog and check the sysadmin box. In this case you are done and can click OK button to create the user group. The user group is now added and ready for ShipWeight.

24 SETTING UP THE USER GROUP WITH MINIMUM PERMISSIONS If it is not desired to give the user group Sysadmin permissions, the minimum server roles is dbcreator which will enable the users to create new ShipWeight projects and in addition the following databases must have db_datawriter and db_datareader for the following databases: SWLogin sdb_demo sdb_shipdb wdb_swbssys wdb_weightdb Select the User Mapping page and check the necessary permission for each of the database.

25 If the minimum permission selected and a ShipWeight user is creating a new ShipWeight project database, by default only this user can access this database. To enable other ShipWeight users to access this database, permissions db_datawriter and db_datareader must be set for the user group in the User Mapping for this project as well as the log project (the log project is named <project>_log). To make these permissions default for the user group for any new projects created even with minimum permission set, a few lines must be added to the files creating new ShipWeight projects. The two files to be edited are ShipWeightDB.sql and ShipWeightDB_Log.sql and is found in the ShipWeight folder at the client machine. Open the files in Notepad or similar and at the end of these files to add these lines. If the user group name is RAA\ShipWeightUsers the lines would look like this: EXEC sp_grantdbaccess 'RAA\ShipWeightUsers' EXEC sp_addrolemember 'db_datareader', 'RAA\ShipWeightUsers' EXEC sp_addrolemember 'db_datawriter', 'RAA\ShipWeightUsers' GO Figure 9: Showing the permission lines added to ShipWeightDB.sql

26 ADDING THE USER GROUPS BY COMMANDS If MSDE is installed as the SQL Server instance, this does not ship with a graphical user interface. While there are many freeware and shareware on the internet offering a graphical user interface (in example at ), this section will show how to add permissions using the command prompt of the OSQL.exe file in MSDE2000 or the SQLCMD.exe which ships with SQL Server The OSQL.exe tool is located here: \Microsoft SQL Server\80\Tools\Binn The SQLCMD.exe tool is located here: \Microsoft SQL Server\90\Tools\Binn Both programs needs to be run from the command prompt (Start >Run Cmd ). This document will show commands run on the SQLCMD.exe file. First, in the command window, navigate to the location of the tool and log on to the SQL instance by using the command sqlcmd S <instancename> (see next page).

27 Figure 10: Example of logging on the instance Next, add the windows user group with the following command: CREATE LOGIN [<windows_usergroup_name>] FROM WINDOWS; Followed by GO Figure 11: Sample of creating the windows group

28 SETTING UP THE USER GROUP WITH SYSADMIN PERMISSIONS If the SQL Server instance is solely for the purpose of ShipWeight and it may be considered whether the user group can have a sysadmin server role. If so, run the command EXEC sp_addsrvrolemember '[<windows_usergroup_name>]', 'sysadmin'; followed by the command GO Figure 12: Example of adding server role "sysadmin" In this case, all setup for the user group is finished. Exit the program by giving the command Exit at the prompt. SETTING UP THE USER GROUP WITH MINIMUM PERMISSIONS If it is not desired to give the user group Sysadmin permissions, the minimum server roles is dbcreator which will enable the users to create new ShipWeight projects (see previous SQLCMD example on how to add serverrole through the command window). In addition the following databases must have db_datawriter and db_datareader for the following databases: SWLogin sdb_demo sdb_shipdb wdb_swbssys wdb_weightdb

29 The commands to set up these permissions for the user group ShipWeightUsers for the database wdb_weightdb would be: USE [wdb_weightdb] GO CREATE USER [RAA\ShipWeightUsers] FOR LOGIN [RAA\ShipWeightUsers] GO USE [wdb_weightdb] GO EXEC sp_addrolemember N'db_datareader', N'RAA\ShipWeightUsers' GO USE [wdb_weightdb] GO EXEC sp_addrolemember N'db_datawriter', N'RAA\ShipWeightUsers' GO Similar commands would be needed for the other databases listed. When finished, exit the program by giving the command Exit at the prompt. For a full overview of all security stored procedures, see us/library/ms182795(sql.90).aspx

30 ENABLING PROTOCOLS FOR MSDE OR EXPRESS 2005 ENABLING PROTOCOLS FOR MSDE By default, MSDE Sp3a is installed with all protocols disabled if options for enabling are not given in the setup command. To enable protocols for MSDE after the installation, follow these steps: To use the SQL Server 2000 Server Network utility to configure an existing instance of SQL Server 2000 or MSDE 2000 not to listen for network connections, follow these steps: 1. If the SQL Server client tools are installed on the computer, open the Microsoft SQL Server program group, and then start the Server Network utility. If the SQL Server client utilities are not installed, run the Svrnetcn.exe file that is in the SQL Server Tools\Binn folder. Generally, the reason the SQL Server client utilities are not installed on a computer is that the computer is only running instances of MSDE 2000 that do not give the user a license to use the SQL Server client utilities. 2. On the General tab, select the name of the instance of SQL Server in the Instance(s) on this computer list box. Click to select servername for the default instance, or select servername/instancename for any named instance. Click OK. 3. To limit the instance of SQL Server to only permit local connections, click Enable until there are no protocols listed in the Disabled protocols list. If you have to change this later to permit remote connections, reverse this process and enable one or more protocols. Restart the instance of SQL Server for the changes to take effect. You can use the SQL Server 2000 Server Network utility to enable network connections to an instance of SQL Server 2000 that is currently configured not to support them.

31 ENABLING TCP/IP PROTOCOLS FOR SQL EXPRESS 2005 SQL SERVER CONFIGURATION MANAGER The SQL Server Configuration Manager is a graphical tool that is automatically installed with SQL Server 2005 Express to enable you to manage many aspects of your SQL Server 2005 installation, such as services, network configuration, and more. Start the SQL Server Configuration Manager from the Configuration Tools group of the SQL Server Express group and expand the SQL Server 2005 Network Configuration and select Protocols for SQLEXPRESS. The default protocols for SQL Server 2005 Express edition are: Shared Memory Secure way for a client to access a SQL Server on the same computer. Shared Memory is enabled by default and cannot be used when accessing SQL Server from across the network. Named Pipes Allows a client to connect to SQL Server by using any of a number of different protocols. The actual protocol used is dictated by the client application by indicating the path, or pipe, needed to access the server. Because of potential security risks, only local Named Pipes is enabled by default. If you want to use the Named Pipes protocol from a remote machine, you'll have to enable this in the SQL Server Surface Area Configuration manager

32 TCP/IP Standard Ethernet protocol that enables a client application to access a specific SQL Server instance using its IP address. Because of potential security risks, TCP/IP is disabled by default. VIA Stands for Virtual Interface Architecture and is a network protocol that is used in high speed networks. VIA is not available in SQL Server 2005 Express. To enable or disable any of the protocols (except VIA), simply right click the desired protocol name and select Enable or Disable as desired. If a protocol is enabled, a client application will be able to connect to SQL Server 2005 Express by using that protocol. For further information on setting up users, database backup or other SQL questions, please do not hesitate to contact BAS engineering office@bas.no