Server Installation: ServerTools

Transcription

1 Server Installation: ServerTools ServerTools Page 1

2 Table of Contents To Install ServerTools...3 Backup and Restore...6 Purpose...6 Background...6 Requirements...6 Creating a Backup Schedule using the Backup and Restore Tool...6 To Restore from a Backup using the Backup and Restore Tool...7 Snapshot Mover...9 Purpose...9 Background...9 How to Use...9 Disable/Enable Replication and Snapshotgen SQL Disable/Enable Replication and Snapshotgen SQL ServerTools Page 2

3 To Install ServerTools This section outlines how to install the following software: Microsoft.NET Framework version 1.1 Champ TouchPoint ServerTools 1. Complete the installation of Champ TouchPoint (SQL Server, MSDE server or standalone workstation). 2. The ServerTools must be installed on the computer running the MSDE. On this computer, first install the Microsoft.NET Framework version 1.1. a. To see if it is currently installed, go to Control Panel, Add/Remove Programs, and look for Microsoft.NET Framework 1.1. b. To download and install from Microsoft: c. The installation may take several minutes. The status bar is NOT accurate, so please allow the installer to finish and disappear even if it looks almost done. 3. Download and save ServerTools from and save it to your desktop. 4. Open the zip file containing the ServerTools. In the ServerTools folder, double-click setup.exe. 5. Click Next to advance the installer. There is nothing to input. Files are created on your computer at C:\Program Files\CHAMP\ServerTools. 6. The installer will add shortcuts for server tools to the Champ program group on your Start menu. Next, configure SQLSERVERAGENT according to the scenario that fits your setup: 1. If you plan to store backup files and the network Champwin folder on THIS computer: a. Right-click on My Computer. b. Choose Manage. This will bring up the Computer Management Windows system tool. c. Expand System Tools, then Local Users and Groups, then click on Users. d. Right-click on the Users folder and choose New User. Name the user champ_sqlagent. e. Uncheck User must change password at next logon. f. Check Password never expires. g. In the Password and Confirm Password boxes, type in a strong password. i. For more information regarding creating strong passwords: h. Click Create, then click Close. i. On the right-hand side of the divider, right-click on the champ_sqlagent user and choose Properties. j. Click on the Member Of tab. Click Add. k. Type Administrators in the text box. Click OK. l. Click OK to close the properties dialog. m. Back on the left-hand side, expand Services and Applications. n. Click on the Services folder. o. Scroll down to SQLSERVERAGENT. Right-click and choose Stop. p. After SQLSERVERAGENT is stopped, right-click on it again and choose Properties. ServerTools Page 3

4 q. Click the Log On tab. r. Select This account and type in champ_sqlagent. Type in the password for champ_sqlagent. s. Click OK. Click OK when it says this account has been granted the Log On as a Service right. t. Right-click on SQLSERVERAGENT and choose Start. u. Close Computer Management. 2. If you do NOT plan to store backup files and the network Champwin folder on this computer: a. Create a domain user account 1. Log on to your Domain Controller as an administrator. 2. On the Start menu, point to Programs, point to Administrative Tools, and then click Active Directory Users and Computers. 3. Right click the Users folder, point to New, then click User. 4. In the New Object User dialog, type champ_sqlagent in the First name and User login name dialog boxes, then click Next. 5. In the Password and Confirm password dialog boxes, enter a strong password. i. For more information regarding creating strong passwords: 6. Select the checkbox Password never expires, then click Next. 7. Close Active Directory Users and Computers. b. Grant privileges on the remote server to the domain user account 1. With an administrative account, log on to the network file server where the Champ database backups will be stored or where the network Champwin folder is stored. 2. On the Start menu, point to Programs, point to Accessories, and then click Windows Explorer. 3. Using Windows Explorer, navigate to the shared folder where the network Champwin folder is stored. 4. Right click the shared folder, select Sharing. 5. In the Folder Properties dialog, on the Sharing tab, click the Permissions button. 6. Click Add, type champ_sqlagent, then click OK. 7. In the Share Permissions dialog, under Group or user names, click and highlight champ_sqlagent. 8. Under Permissions for champ_sqlagent check Allow Full Control, then click OK. 9. In the Folder Properties dialog, click the Security tab, then click the Add button. 10. Type champ_sqlagent, then click OK. 11. Under Group or user names, click and highlight champ_sqlagent. 12. Under Permissions for champ_sqlagent check Allow Full Control, then click OK. 13. Close Windows Explorer. c. Grant privileges on the local server to the domain user account 1. Log on to the Champ database server with an administrative account. 2. If the server is not a domain controller: a. On the Start menu, point to Programs, point to Administrative Tools, and then click Computer Management. b. Expand Local Users and Groups, then click on Groups. ServerTools Page 4

5 c. Right click on Administrators, then select Properties. d. Click Add, then type champ_sqlagent in the dialog box, then click OK. e. Close Computer Management. 3. If the server is a domain controller: a. On the Start menu, point to Programs, point to Administrative Tools, and then click Active Directory Users and Computers. b. Right-click the Users folder, navigate to champ_sqlagent. c. Right-click on champ_sqlagent, click Add members to a group. d. Type Administrators, then click OK. 4. Close Active Directory Users and Computers. d. Configure SQL Server Agent to run using the domain user account 1. On the Start menu, point to Programs, point to Administrative Tools, and then click Services. 2. Right-click SQLServerAgent, and then click Properties. 3. Select the Log On tab. 4. Select the This account: button, then enter champ_sqlagent for the Username. 5. In the Password and Confirm password dialogs, renter the password for champ_sqlagent, then click OK. 6. On the Start menu, point to Programs, point to Microsoft SQL Server, and then click Service Manager. 7. In the Server dropdown list, select the name of your server. 8. In the Services dropdown list, select SQL Server Agent. 9. Click the Stop button, then wait until the Server icon displays a red square. 10. Click the Start button, then wait until the Server icon displays a green triangle. 11. Close Service Manager. 3. All other scenarios: a. SQL Server Agent requires administrative privileges on the SQL Server computer. b. SQL Server Agent requires read/write privileges on the computer hosting Champ backups and the Champwin/snapshot folder. 4. Installation and configuration is complete. ServerTools Page 5

6 Backup and Restore Purpose This application will allow agencies using the MSDE to create backup schedules and restore the Champ database. If using SQL Server, do NOT use this tool use the utility provided with your SQL Server. Background Internally, backups are performed by the Microsoft SQL Server Agent. Backup and Restore only exposes the ability to create a SQL Server backup schedule. This tool was intended for users running Champ TouchPoint on the Microsoft SQL Server Desktop Engine (MSDE) which provides no native graphical interface to create these backup schedules. Requirements SQL Server Agent o Auto-start Backup location o SQL Server Agent User account Creating a Backup Schedule using the Backup and Restore Tool 1. Go to Start, Programs, CHAMP, Backup and Restore. 2. If the following screen appears, go to the section on pages 1-2 for configuring SQL Server Agent. 3. The main menu screen will come up: ServerTools Page 6

7 4. Click Add to create a new backup schedule. The following screen will come up: 5. Choose the options you d like for the backup schedule. a. Name used by the main menu screen, should reflect the type of schedule. b. Frequency how often you d like the database to be backed up. c. Duration the length of time you d like this schedule to execute. d. Time when the backup file is created. To change the hour, click on the hour, then use the arrows. Click on minutes and use arrows to change minutes as well. e. Retention how long old backup files are saved. For example, if this value is 7 days, backup files older then 7 days will be deleted when the backup runs. f. Location where the backup file is stored. We recommend backing up your database to either a computer with a tape backup drive that is regularly used or to another storage device, such as a CD. It is usually not enough to just backup your database to the machine it is on at least weekly or monthly a backup should be transferred to a different storage device such as a CD. 6. Click Save to set the backup schedule. This will return you to the main menu screen. 7. Add, Edit, and Delete schedules as needed. To Restore from a Backup using the Backup and Restore Tool 1. Go to Start, Programs, CHAMP, Backup and Restore. 2. The main menu screen will come up: 3. Click Restore (this button does not use the schedule selected). ServerTools Page 7

8 4. Restore will attempt to navigate to where your backup files are stored. You may have to manually navigate to the files: a. Backup files are named champ_v2_db_ bak. b. The numbers in the file name are dates and times, in the format: YYYYMMDDTTTT. Y=year, M=month, D=day, and T=time (military/universal time). c. The file extension is.bak, for Backup files. 5. Select the backup file you wish to restore from. Click Open. 6. A message will warn that restoring a backup will require starting and stopping SQL Server. If software programs are dependent on SQL Server/MSDE, it is best to perform restores after normal work hours to avoid interrupting users. Click Yes to continue. 7. The application will attempt to restore the database. This may take a few minutes, and will display the following status bar: 8. A message will pop up at the end indicating whether the restore was successful or not. 9. If unsuccessful, attempt to restore again. You may need to restart SQL Server and SQL Server Agent. Contact Champ support if restore does not work after several attempts. ServerTools Page 8

9 Snapshot Mover Purpose To provide administrators the ability to update the snapshot folder location used by Champ Transfer. Background Champ Transfer uses a SQL Server feature called Replication. SQL Server Replication creates the snapshot folder in the network Champwin folder during installation. If the network Champwin folder is renamed or moved, SQL Server Replication must be updated. How to Use 1. Make sure all charts are checked in. Charts left checked out may lose changes made to data on the local mobile computer. 2. Make sure all users are signed out of Champ. 3. Move the Champwin folder to its new location, if applicable. 4. Go to Start, Programs, CHAMP, Snapshot Folder Mover. 5. If the following screen appears, go to the section on pages 1-2 for configuring SQL Server Agent. 6. If the following screen appears, you are not on the Champ database server or you are attempting to use this utility from a stand-alone. This utility can only used on the Champ database server. 7. The main screen will come up: 8. Click Browse to select the new location for the snapshot folder. The following screen will come up: ServerTools Page 9

10 9. If needed, click New Folder to create the new snapshot folder. If the new snapshot folder already exists, select it and click OK. 10. A progress bar will appear as replication is configured to use the new snapshot folder. This step will take several minutes. 11. After configuration is complete, the following success message will appear. Click OK and the application will close. 12. You can further ensure that this application worked successfully by navigating to the new snapshot folder and verifying it contains a folder named unc as well as several subfolders below unc. ServerTools Page 10

11 Disable/Enable Replication and Snapshotgen SQL Make sure all charts are checked in and all users are logged out of CHAMP. Changes made to charts on laptops will be lost if not checked in. 2. On the SQL Server, open a command prompt and run the following commands to disable replication: a. Change directory to: C:\Program Files\CHAMP\ServerTools b. Type: change_schema /d /r /s [servername] /p [sa password] *Example: change_schema /d /r /s mysqlserver /p mypassword *Note: If the table won t drop replication, run this (from OSQL prompt): *If errors occur, run Change Schema with the same parameters again. NOTE: the most common problem here is a timeout error. If it fails more than 6 times try rebooting the server and running the command again. 3. At command prompt, run this command to enable replication: change_schema /e /f \\[servername]\[sharename]\champwin\snapshot /s [servername] /p [password] *Example: change_schema /e /f \\myserver\shared\champwin\snapshot /s mysqlserver /p mypassword 4. At command prompt, run this command: snapshotgen [computername] [sa password] *A progress bar will appear and create the contents of the snapshot folder. If no progress bar appears and you see an error in the Command-Line window, contact Champ support. *The progress bar will configure 3 publications. This will take several minutes. After it completes, it will disappear. It will NOT display a completed successfully message. *Validate the snapshot folder was successfully created by navigating to the Champwin folder, then the snapshot folder. There should be a folder titled unc in the snapshot folder, and under unc should be several other folders. If these do not exist, contact Champ support. 5. Run Trans_setup.exe on each laptop that replicates: a. Browse to the C:\Champwin\BINSQL folder on the laptop b. Find trans_setup.exe, right click on it and select Open ServerTools Page 11

12 It will take several minutes for anything to happen. You will eventually see a progress bar that indicates the process is running. Once the window disappears, the process is complete. 6. Test transfers on laptops. ServerTools Page 12

13 Disable/Enable Replication and Snapshotgen SQL Make sure all charts are checked in and all users are logged out of CHAMP. Changes made to charts on laptops will be lost if not checked in. 2. On the SQL Server, open a command prompt and run the following commands to disable replication: a. Change directory to: C:\Program Files\CHAMP\ServerTools b. Type: change_schema /d /r /s [servername] /p [sa password] *Example: change_schema /d /r /s mysqlserver /p mypassword *Note: If the table won t drop replication, run this (from OSQL prompt): *If errors occur, run Change Schema with the same parameters again. NOTE: the most common problem here is a timeout error. If it fails more than 6 times try rebooting the server and running the command again. 3. At command prompt, run this command to enable replication: change_schema /e /f \\[servername]\[sharename]\champwin \snapshot /s [servername] /p [password] *Example: change_schema /e /f \\myserver\shared\champwin\snapshot /s mysqlserver /p mypassword 4. In SQL Server Management Studio, do this to generate the snapshot: a. Open the SQL Server Management Studio: b. Expand Replication & Local Publications c. Right click on each of the three publications d. Select View Snapshot Agent Status e. Click on Start and wait for each to complete to 100% f. Close each window 5. Run Trans_setup.exe on each laptop that replicates: a. Browse to the C:\Champwin\BINSQL folder on the laptop b. Find trans_setup.exe, right click on it and select Open It will take several minutes for anything to happen. You will eventually see a progress bar that indicates the process is running. Once the window disappears, the process is complete. 6. Test transfers on laptops. ServerTools Page 13