Shelter Pro Installation Guide SQL Server Backend. Server Side Requirements Overview. Shelter Pro Installation Guide SQL Server Backend Page 1

Transcription

1 Server Side Requirements Overview This document describes how to install the Shelter Pro as a client/server application with Microsoft SQL Server as the backend database engine. This overview section gives a high level synopsis of the installation requirements. Requirement 1 - SQL Server 2005 or later must be installed Microsoft SQL Server 2005 or later is required. This can be any edition of SQL Server including express (note that express editions will restrict the database size to a maximum of 10GB). SQL Server is provided by Microsoft and is not provided or installed by Shelter Pro Software. If you don t already have SQL Server the software can be downloaded from If you will be doing a first time install of SQL Server, you ll want to download the SQL Server with Advanced Tools as this installation package will typically include SQL Server Management Studio. If needed, in-depth support and assistance with establishing SQL Server will be covered in documentation provided by Microsoft. For purposes of Shelter Pro deployment using SQL Server there are two requirements in working with SQL Server: 1) SQL Server Management Studio When SQL Server is installed, the installation should include SQL Server Management Studio. This application is necessary to work with SQL Server as a DBA (Data Base Administrator). This document will reference and show screen samples with SQL Server Management Studio to illustrate the Shelter Pro deployment in your network environment 2) SQL Server Configuration Manager The SQL Server installation will also install an interface program called SQL Server Configuration Manager. This tool facilitates the connectivity of SQL Server on the network. Requirement 2 - File Server Shared Folder A Shared Folder will be required on a file server. This folder and its subfolders will be automatically created during the installation process provided by ShelterPro_InstallSQLServerBackend.exe (discussed in more detail later in this document). This folder may reside on the same machine where SQL Server is installed, or it can be another machine which acts as a shared file server. Page 1

2 Overview (continued) Requirement 3 SQL Server Configuration Manager items required for Shelter Pro The following items are required and are set using SQL Server Configuration Manager: 1. SQL Server Services the services titled SQL Server and SQL Server Browser must be running. The start mode properties for these services should be set to automatic so these services will automatically initiate when the server is running. Both processes should also be running in Network Service Mode so that the SQL instance/service is visible on the network. 2. SQL Server xxxx Network Configuration the Protocols for SQL Server should have Shared Memory, Named Pipes and TCP/IP enabled. 3. SQL Native Client Configuration the Client Protocols should have Shared Memory, Named Pipes and TCP/IP enabled. Note: it may be necessary to first install SQL Native Client to have these items be defined within the SQL Server Configuration Manager. The installation of SQL Native Client is discussed later in this document. Page 2

3 Installing Shelter Pro s SQL Server backend Assuming the above requirements have been met and your server has MS SQL Server installed and properly configured and described above, follow the steps below to install a Shelter_Pro database on the server. Be sure to run the link below when prompted. Page 3

4 You should now see the WinZip self-extractor. Click Unzip to extract the folder to the machine. It is highly recommended that you do not change the folder name from c:\shelpro as this makes ongoing support easier. The unzip will create the c:\shelpro folder structure and subfolders/files as shown below. Page 4

5 The next step is to share the C:\Shelpro folder with all users and grant full control permissions. The typical steps are: 1. Go to the root C drive; 2. Right-click the Shelpro folder and select properties; 3. Click on the Sharing tab and share the folder with the user group or with the Everyone group; 4. Go to the Security tab and click Users; 5. Modify the permissions to give users Full Control and apply. Page 5

6 Attaching the Shelter_Pro database to SQL Server The provided Shelter_Pro database referenced on the previous page must be attached to SQL Server so that the SQL Server engine can manage the day-to-day usage of Shelter Pro by your end users. To connect the Shelter_Pro database to SQL Server: 1) Start SQL Server Management Studio and connect to the SQL Server instance. In this document the instance name is SURFACEBOOK\SQL2005. Your server s instance name will be different. Identifying the instance name to Shelter Pro will occur when the client software is implemented and is discussed later in this document; 2) Right-click databases and select Attach; 3) On the Attach Databases screen click Add; 4) Navigate to the c:\shelpro\remote\sqlserver_database folder, select the Shelter_Pro.mdf file, and click OK; Page 6

7 Attaching the Shelter_Pro database to SQL Server (continued) 5) On the Attach Databases screen click OK. You should now see the Shelter_Pro database under the SQL Server instance. SQL Server instance name (SURFACEBOOK\SQL2005) with Shelter_Pro as an attached database. Page 7

8 SQL Server user permissions For Shelter Pro end users, the necessary SQL Server permissions are defined the Security settings of the attached Shelter_Pro database. The permissions are already preset with the out-of-the-box Shelter Pro database which was attached in the previous steps. The necessary permissions are: db_datareader db_datawriter db_ddladmin Customers are able to define their own security approach per their own requirements, including: 1) Windows Authentication the default; 2) Defining security groups ; 3) Individual logins. The out of the box Shelter_Pro database is initially set assuming Windows Authentication will be used, and the necessary permissions are preset. If you will be using Windows Authentication, then these initial settings should be sufficient and the remaining part of this section is informational. Note that this document only covers the Windows Authentication method. If any of the other security methods are chosen, make sure the necessary permissions (db_datareader, db_datawriter, and db_ddladmin) are allowed. For Windows Authentication, the permissions can be viewed/verified/modified using the Builtin users as is shown in the example screens below. Notice the folders defined under the Databases Shelter_Pro / Security / Users / BUILTIN\USERS. Here is a sample of the expanded view: Page 8

9 SQL Server user permissions (continued) Page 9

10 Install Shelter Pro Client Software to the shared folder The next step is to install Shelter Pro s client software to the shared folder on the server. Be sure to run the link below when prompted. You should now see the WinZip self-extractor. Click Unzip to extract the folder to the machine. It is highly recommended that you do not change the folder name from c:\shelpro as this makes ongoing support easier. Page 10

11 Page 11

12 Install Shelter Pro Client Software to the shared folder (continued) The unzip will create the c:\shelpro folder structure and subfolders/files as shown below. Page 12

13 Install Shelter Pro Client Software to the shared folder (continued) The next step is to set Windows user permissions to the shared folder on the server. Follow these steps: 1. Access the shared Shelpro folder on the C drive. Right click the folder and select Properties; 2. Click the Sharing tab and then click the Share button. Page 13

14 Install Shelter Pro Client Software to the shared folder (continued) 3. Type Everyone in the text box, and click Add; 4. Change the Permission Level from Read to Read/Write for the Everyone group, and then click Share ; Page 14

15 Create a Shelter Pro desktop icon This step is very quick and can be repeated on client workstations which will be running Shelter Pro client software. 1. Right-click shelpro.exe, 2. Click Send to, click Desktop (create shortcut) ; 3. You should now have a desktop icon named shelpro.exe. Right-click the desktop icon and rename it to Shelter Pro Page 15

16 Running Shelter Pro for the first-time Double-click the Shelter Pro desktop icon for the first-time launch of Shelter Pro. You should then see the Database Connection Settings screen. IMPORTANT: 1) Make sure the Data Connection Folder is set to the REMOTE folder; 2) Check the Use SQL Server box; 3) Set the SQL Server Instance Name to your named instance of SQL Server. Special note SQL server is a server process. The example below shows SURFACEBOOK\SQL2005. Note that this is not a folder path, rather it s the defined service name running on the server. Your SQL Server Instance name will be different and can be found using SQL Server Management Studio. Refer to page 7 in this document for a visual on how this name is known on your server. 4) Click Test SQL Server Connection and verify that you get the message Test Connection Successful. 5) Click Close/Continue and follow any prompts presented as Shelter Pro sets up the database for first-time use. If everything is working you will come to the Shelter Pro login screen. Click Exit to exit Shelter Pro and move on to installing the workstations. Page 16

17 Installing the Shelter Pro client workstations Now that the server-side component of Shelter Pro is functioning, all other workstations can be setup with desktop icons for the user group. For each workstation: 1. Access the shared Shelpro folder on the server; 2. Right-click shelpro.exe, click Send to, click Desktop (create shortcut) ; 3. You should now have a desktop icon named shelpro.exe. Right-click the desktop icon and rename it to Shelter Pro 4. Start Shelter Pro from the desktop icon. You should get to the Shelter Pro login screen. Page 17

18 Installing the Shelter Pro client workstations (continued) The final step is to create desktop icons for Shelter Pro s documentation. Access the shared Shelpro/HELP folder on the server, right-click Shelter_Pro_Administration_Guide.pdf, click Send to, click Desktop (create shortcut). Repeat this same step for Shelter_Pro_Users_Guide.pdf. You should now have a desktop icon for each document. Just FYI - The documents will cover the detailed functions and configurations of the Shelter Pro Software application. The Shelter Pro Users Guide This document should be printed and referenced by the Shelter Pro users such as staff members who will process events on Shelter Pro, such as Animal Control incidents, Shelter Cases, Animal Licensing, etc. The Shelter Administration Guide This document should be used by the Shelter Pro users who will fill the role of system administrators of Shelter Pro. These functions would include things such as Shelter Pro user administration, system configuration items for event processing in the Shelter Pro modules, etc. Page 18

19 Unlocking the database Note that the final step after install is unlocking the Shelter Pro database assuming the software has been purchased. A new Shelter Pro setup is initially in a demo mode and will be fully functional until the demo period expires (this is typically 21 days). The final unlock must be done over a phone call by calling Shelter Pro Software at our primary contact number before the demo period expires. Database backups Note that data/server backups are a customer responsibility. Regular server backups should be in place to safeguard your data, both Shelter Pro data and any other mission critical data necessary for business operations. There is an automatic data backup functionality included with Shelter Pro which can be deployed, or there is the option to utilize other SQL Server backup processes. as this is a broader consideration beyond solely the Shelter Pro database. Hand it over Notify the user group that Shelter Pro is ready to go. It is recommended that IT support be present with them to ensure they can initially access the application and begin using their new software. Note that they will need to use Shelter Pro to establish the Shelter Pro users, their permissions within Shelter Pro, Shelter Pro application configuration, etc. Details are discussed in The Shelter Pro Administration Guide. Page 19