User Guide. Database Backup Procedures for MS SQL Server 2005 Express

Transcription

1 User Guide Database Backup Procedures for MS SQL Server 2005 Express

2 System Galaxy-8 Software Addendum Documentation SG Version 8 January, 2008 ~ i ~

3 System Galaxy Version 8 Software Addendum Information in this document is subject to change without notice. Therefore, no claims are made as to the accuracy or completeness of this document. first edition Jan 2008 Copyright 2008 Galaxy Control Systems All rights reserved No part of this document may be reproduced, copied, adapted, or transmitted, in any form or by any means, electronic or mechanical, for any purpose, without the express written consent of Galaxy Control Systems. Copyright protection claims include all forms and matters of copyrighted material and information, including but not limited to, material generated from the software programs, which are displayed on the screen such as icons, look and feel, etc. Trademarks Microsoft, Windows, Windows NT, MSDN and SQL Server TM are registered trademarks of Microsoft Corporation in the U.S. and other countries. Adobe, Acrobat are registered trademarks of Adobe Systems Inc. Graphics and illustrations by Candace Roberts, SQA & Technical Writer. Galaxy Control Systems 3 North Main Street Walkersville MD ~ ii ~

4 Table of Contents chapter-page Introduction and Requirements 1 Outline and Scope of Document 1 Sections in this Document 1 MUST READ! - About Your Backups and Disaster Recovery Plan 2 Why do I need a Disaster Recovery Plan? 2 What is a Disaster Recovery Plan? 3 Minimum Requirements for Backing up your files 5 Section-1 Creating a Backup Folder 6 About Backing-up to an External Drive 6 About Backing-up to the Local Drive 7 Choosing the standard MS SQL Backup folder (recommended) 7 Choosing a non-standard Backup folder 7 Section-2 Configuring Backups in GCS Service Manager 8 Opening the Galaxy Database Backup Utility 8 Setting the Backup Path/location 9 Providing the Database Security Settings 10 Choosing the Databases to Backup 10 Creating the Backup Scripts 11 Section-3 Running a Test Backup in GCS Service Manager 12 Testing the Database Backup Scripts 12 Section-4 Creating a Scheduled Backup 13 ~ iii ~

5 Setting the Start-Time of the Scheduled Backup Task 14 Setting User Account & Password for a Scheduled Backup 15 Saving the Backup Task 16 Verifying your Backups Occurred Correctly 17 Section-5 Modifying your Backup Task 18 Opening the Windows Task Scheduler 18 Setting the Task Properties in Windows Scheduler 18 Setting the Schedule Properties in Windows Scheduler 19 Setting Task Start Path & Password in Windows Scheduler 20 Section-6 Automating the backup of other SG Files 21 Creating the Backup Batch Files for each SG folder 21 Creating the Scheduled Task for the Backup Batch Files 22 Section-7 Restoring the Backup Files 23 ~ iv ~

6 Introduction and Requirements Outline and Scope of Document This manual is geared for smaller sites that use MS SQL Server 2005 Express engine which is included in the System Galaxy software suite. Larger corporate and enterprise sites will typically use Full SQL Server This document describes how use the DBBackup Utility in the GCS Service Manager to create database backup scripts and setup Scheduled Tasks to automated database backups. This document also covers creating batch files that automate the back up of other System Galaxy files such as Audio file, badging photos, fingerprints, reports, etc. NOTICE: This manual is not intended to dictate, replace, or advise managers on the best up-todate solution concerning the security of data, databases and other access control assets. IMPORTANT: A qualified Database Administrator (DBA) and IT Administrator should be involved in establishing safe practices for handling the SG data/databases/assets for backups and disaster recovery plans. This document only covers a basic technique of automating SG database backups and other SG assets using the GCS Service Mgr Backup Utility, backup scripts, batch files and the Windows Task Scheduler (for small systems using MS SQL 2005 Express). This document does not tell you how to create or administer rights to the database and backup folder(s). Please see your DBA and IT Professional for that assistance. This manual does not cover every possible scenario, warning or limitation of handling database backups or database restoration. A qualified DBA and IT Professional should be consulted. Sections in this Document Section-1 Creating a Backup folder (i.e. backup device/location of the backup) Section-2 Configure the Backup Settings from the GCS Service Manager Section-3 Run a test database backup from the GCS Service Manager Section-4 Create a scheduled database backup task from the GCS Service Manager Section-5 Modify a scheduled backup in MS Task Scheduler Section-6 Tips on automating backups of SG Assets (photos, templates, fingerprints, etc.) Section-7 Restoring Backup Files Page 1 of 23

7 MUST READ! - About Your Backups and Disaster Recovery Plan It is the responsibility of the database owner/administrator to develop and implement a proper Disaster Recovery Plan. If the database owner transfers the responsibility to another party, it is the responsibility of that party and the database owner to develop and implement the agreed upon Recovery Plan. This document covers the portion of the disaster plan that pertains to backing up and restoring the databases and other SG Files. Why do I need a Disaster Recovery Plan? You should always have a proper disaster Recover Plan for your databases and other system assets (audio, graphics, photos, badge templates, fingerprints, etc.). A disaster recovery plan saves you time, money and grief. NOTE: Your System Galaxy hardware is designed to continue functioning with its currently loaded data and programming when the system database and software are offline. The hardware saves the last 10,000 events in a memory buffer at each controller. Eventually it will begin to overwrite the oldest events as more time passes without being connected to the database. All the programming that was loaded into the hardware was generated from the software programming and is stored in the SysGal database. You will want to get your system files and databases restored as soon as possible. If the server and controllers sustained damage at the same time from lightening strike or other natural disasters, then it is very difficult to get the system up quickly without a backup. Notice: If you had made changes to the programming in the software/database but did not take a recent backup of that data, then you must manually reprogram that data. Page 2 of 23

8 What is a Disaster Recovery Plan? A Disaster Recover Plan is a combination of the steps you take to restore your system should a disaster occur. Obviously it includes maintaining current/recent backups of the SG databases and other SG assets. A disaster could be that the hard-drive on the server goes bad, a database corruption occurs, lightening, etc. A Disaster Recovery Plan includes, but is not limited to: IT Security Measures: backup locations and security measures to protect the backups from intrusion is the responsibility of the database owner. Creating a secure Backup Device (location for the backups): The utmost care should be taken to protect your backups and limit access to the backup folder. Again, protecting the backups from intrusion is the responsibility of the database owner. Performing timely backups of the data/databases: 1. An initial Full Backup should be done as soon as initial site configuration and registration is completed. This can be done by the Access Control Dealer/Service Provider, or by the customer. 2. Periodic Full Backups should be repeated on a schedule that is determined to reasonable by the database administrator. Important considerations are storage space, database size as well as amount of activity and system changes. If you add a lot of cardholders and access groups, or change/expand the system configuration, you might consider doing a manual backup instead of waiting on the scheduled task. 3. Differential (partial) Backups could be done between periodic full backups only if the if the system size or dictates. These are tricky to execute and restore properly. Differential backups require a qualified DBA and are not covered in this document. Performing timely backups other SG Assets (i.e. audio files, graphics, photos, fingerprints, badging design templates, reports, icons, logos, Sagem fingerprint templates, etc.). These System Galaxy(SG) assets are also very important system files and should to be included in the system recovery plan. These files are not a part of the database backup, but should be part of your backup process. Verifying the backups occur correctly and can be used for restoration: 1. A complete dry-run of the Disaster Recovery Plan should be done and should include the act of restoring the files and databases. This allows you to prove the process you have chosen can successfully restore your system. The steps of the recovery process should be carefully documented to ensure that the system can be successfully recovered from the backups if the future need arises. 2. Always check files, folders and results logs (txt file) every time your backups run to see that the files were truly copied and no errors were encountered. Page 3 of 23

9 Keeping a fire-safe copy of your Backups and Assets: System restoration is crucial when a disaster occurs. It is costly and sometimes impossible to recover data when backups are performed and are not kept safe. Fire, flood, vandalism, virus attacks, and equipment or hard-drive failure are some ways assets can be permanently lost. Data corruption can occur without warning despite best efforts. 1. If you backup to a network drive or external drive (recommended) then you should save a copy of the backups in a fire-safe location. 2. If you backup to a local hard drive folder you should always put a copy of those backups in another secure location (preferably fire-safe). If a data corruption or equipment/hard-drive failure occurs, you could lose everything if your only backups were on the same server. 3. Your System Galaxy Installation CD and software key should always be kept in a safe location. If a server goes down and you have to reinstall your software, you will need your Install CD and may also need your software key (the product key number found on the CD). Page 4 of 23

10 Minimum Requirements for Backing up your files IMPORTANT Backup Folder Locations: The backup folder must be created/exist before the backup is executed. IMPORTANT Folder Permissions: The backup folder must have proper permissions in order to execute the backup and restore from that location. If you are backing up to a non-standard folder on the local drive you must give the correct permissions to the chosen folder. IMPORTANT Backing up SG files and databases: The main & archive databases and other SG files should be included in the initial and periodic backups. Backup scripts, batch files and results files should also be backed up. IMPORTANT Backing up databases: The MS-SQL Server services must be running and the databases must be attached to perform a backup. IMPORTANT Timing of backups: Ideally the backups of databases (manual or automated) should be taken when the system is the least busy. You want to take backups on a regular periodic basis to capture event history and audit trails. Always do a full backup of all databases and SG files before you upgrade the system or databases. Always do a full backup of all databases and SG files after any upgrade or significant change to the system programming, or when you have added cardholders, badges and access groups, etc. IMPORTANT Scheduled Backup Task: The server where the backup task is created/executed must be on and able to connect to the backup device and must have a valid user account and login that has rights to run the backup successfully. IMPORTANT Backup drive: The drive (local, network, or external) must be in place and accessible when the backup tasks executes. Using UNC paths are recommended for IP networks/domains. Drive space should be considered. Proper IP connections must be established. IMPORTANT Fire-safe Backup: a fire-save copy of the backup files, databases and assets should be maintained and kept current. IMPORTANT Network and Data security: appropriate security measures should be taken to protect data and backups from intrusion and theft. IMPORTANT Verify your Database Backups: you should always verify the database backups each time they occur whether they are done manually or automated. This includes checking that the files actually copied and the Backup Results text files do not contain errors. NOTICE for Backup Processes: this manual describes how to run full Backups. Differential backups are only recommended for very large systems where there is a qualified Database Administrator (DBA) to manage the process of running or restoring the differentials. Full backups should be done periodically to prevent database corruption. Page 5 of 23

11 Section-1 Creating a Backup Folder You can backup your databases to your local computer, or on an external drive. Depending on your situation, one method may be more advisable than another. If you must backup to a local drive, be sure to put a copy of the backup files in a secure location (preferably fire-safe). Always include your DBA and IT Administrator in creating a backup process for your databases. Then information in your database is important to protect. About Backing-up to an External Drive 1. Create the backup folder before you run the backup (and before you create the backup batch and script files). REMEMBER that the database backup must be stored in a folder that you have the ability to write, read and copy from. You will need to move your backup files back to the server to restore. 2. FULLY TEST YOUR INITIAL BACKUP! a. You should verify that you can execute the backup to the chosen location. NOTICE: Sections-2 thru 5 provide specific instructions on using the GCS DBBackup Utility to automate your database backups. Section-6 covers other SG files. b. You should also verify and that you can restore your database from that backup file. This may mean you will need to copy/move your backup files into a folder on the server (such as the SQL Backup folder) in order to restore. NOTE About Restoring: you may need to make a backup device in the SQL Management Studio before you can actually restore from your backups. Section-7 covers restoring. 3. ALWAYS VERIFY EACH BACKUP! a. Check the backup folder for the presence of the SysGal_[curr-date/time].bak, the SysGalArc_[curr-date/time].bak, the SGBackupResults.txt, the SGDBBackup.bat, and the SGDBBackup.sql files. b. Open the SGBackupResults.txt file and verify that it does not contain errors. A successfully result looks like the example below you should see the same set of messages for the SysGalArc database and log file. EXAMPLE OF A GOOD RESULTS FILE: Processed 1152 pages for database 'SysGal', file 'SysGal' on file 1. Processed 2 pages for database 'SysGal', file 'SysGal_log' on file 1. BACKUP DATABASE successfully processed 1153 pages in seconds(4 MB/sec). REMEMBER: you must have the backup drive in place when the backup is executed. REMEMBER: you should also the SG assets (badging photos / templates, icons, graphics, fingerprints, reports, etc.) in your back-up process (see Section-6). Page 6 of 23

12 About Backing-up to the Local Drive For those who are not on a domain (e.g. work groups or standalone) and must back up to a local folder, you can use the standard MS SQL Backup folder (recommended). It is possible to use a non-standard folder, but you may need to add the MSSQLUser to the folder user permissions or turn on sharing. It is not recommended to turn on simple sharing as sharing may leave the folder and your data vulnerable to intrusion. Choosing the standard MS SQL Backup folder (recommended) The MS SQL Backup folder is created when your MS SQL 2005 Server instance is installed. The SQL Backup folder should already have the correct permissions. That path typically looks like [ C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup ] If you wish to automate or schedule your database backups and are using SQL 2005 Express, you will need to and use the Windows Task Scheduler. This process requires scripts and batch files. System Galaxy provides a Backup Utility that creates the script and batch files runs and creates the scheduled task (explained in Sections-2 thru 5). Choosing a non-standard Backup folder You can choose to place your backups in a folder other than the MS SQL Backup folder. This folder will not have correct permissions by default, so you will have to add the MSSQLUser account to the Security tab in the folder properties screen. Create the Backup Folder before you execute the backup. The GCS Database Utility defaults a non-standard folder path of C:\Program Files\System Galaxy\Utilities\Backup. The DBBackup folder isn t put down at time of the software install. It is created automatically by the GCS Services Manager Utility when you create the backup scripts using the default location (explained in the next section). Enable security privileges for the MS SQL User account by adding the MSSQLUser to the folder Security tab in the folder properties. Page 7 of 23

13 Section-2 Configuring Backups in GCS Service Manager Opening the Galaxy Database Backup Utility You can navigate through the Windows Start Menu: Start > Program Files > System Galaxy > Utilities > GCS Service Manager. Once the Service Manager is open, select (highlight) the SQL Database Service: Click the [Configure SQL Server Backup ] button that appears when the service is highlighted. Page 8 of 23

14 Setting the Backup Path/location Set the default location (folder) where you want the files to be placed: a. USE DEFAULT NON-STANDARD FOLDER: the [ Select folder ] path defaults to the System Galaxy\Utilities directory on the local hard drive (see figure below) which a non-standard backup location. This folder is automatically created the first time you click the [Create Backup Files]. You may need to edit privileges on this folder before you can backup the first time. MSSQLUser must be added to permissible user accounts in the Security Tab of the folder properties. b. Or BROWSE TO THE STANDARD FOLDER OR EXTERNAL DRIVE: To the right of the [Select folder] path, there is a browse [ ] button. Click this button to browse to your standard SQL Backup folder or an external drive folder you chose in the last section. The standard SQL backup path typically looks like [ C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup ]. NOTE: the folder must already exist for the backup to occur successfully. Page 9 of 23

15 Providing the Database Security Settings Set the Database User ID and Password used to access the database: Choosing the Databases to Backup Click/check the Database checkboxes to set which databases to backup: Page 10 of 23

16 Creating the Backup Scripts Click [ Create Backup Files ] button to create the.sql and.bat files necessary to execute the backups: The following dialog should display when backup scripts are created: You can click [yes] to look at these files they open in Notepad. Be careful not to alter or save changes to these files. The backup will not occur if these files are damaged. Page 11 of 23

17 Section-3 Running a Test Backup in GCS Service Manager Testing the Database Backup Scripts Click [ Run / Test Backup ] button to execute or test your backup: You can use this button to run an ad-hoc manual backups of your databases if you do not wish to automate your backups in task scheduler. Notice: if you are backing up to a different directory than is shown in the default path, you will have to browse to it each time you do a manual backup. If you are going to automate this backup you can use this utility to create the task. It will use the path you browed to when you made the script files every time it runs from the Windows Task Scheduler. The following files will be found in the backup folder location: SysGal_[curr-date/time].bak SysGalArc_[curr-date/time].bak SGBackupResults.txt SGDBBackup.bat SGDBBackup.sql The BAK file names include the current date/tame of the backup; they will not be overwritten by the next backup; you will have to monitor drive space This file will contain the results (success or errors) for the last backup that was executed These files were created when you clicked the [Create Backup Scripts] button. They should not need to be recreated unless you change where you want to backup (location) or which databases you want to backup Page 12 of 23

18 Section-4 Creating a Scheduled Backup You can set up an automated (scheduled ) task to run your backups: This uses the Windows Task scheduler to run backups automatically. IMPORTANT: if backing up to an external drive the target drive must be present. IMPORTANT: You must have already created and selected your folder using correct permissions (described in the previous section). IMPORTANT: You must have already created the backup scripts and executed a test backup to verify you backup can run manually before you create a Backup Task. IMPORTANT: The MS SQL Server service must be running and the databases must be attached in order for the backup to execute properly. NOTE: You will not need to stop GCS Services or shut down the software. NOTE: Choose a time that the system is least busy. Page 13 of 23

19 Setting the Start-Time of the Scheduled Backup Task Set the [Start time] field the Hour and Minute. Remember to set the AM/PM field as needed. (12:00:00 PM is noon; 12:00:00 AM is midnight) NOTE: If backing up to an external drive, it must be installed/connected when the task runs. NOTE: The backup task must be created on the database server (computer hosting the databases) NOTICE: The database server must be up and running in order for the Backup Task to kickoff/run. IMPORTANT: You must add valid account information in Windows Task Properties after you create/save the task in this screen (explained in following steps). Page 14 of 23

20 Setting User Account & Password for a Scheduled Backup Set the [Run as ] field the PC name and User Account login that you want the task to run under: The machine name must be valid The user name must be a valid account on the local PC Set the [Password ] field for the User Account login that you want the task to run under: The password must be valid for that user s account Page 15 of 23

21 Saving the Backup Task Click the [Save Scheduled Backup Task ] button to create the scheduled task: The task will be visible in the Windows Task Scheduler (see next section) The following dialog should display. To modify the task further (i.e. to set frequency, etc.) go to the computer s Control Panel folder and open the Scheduled Task folder. Page 16 of 23

22 Verifying your Backups Occurred Correctly You should see the following backup files in the target folder: The SGBackupResults.txt file = includes results of the backup script s execution The SGBackup.bat file = the batch file that runs the SQL script The SGBackup.sql file = the script file that executes the backup The sysgal_mm-dd-yyyy_hh_mm_am.bak file = the SysGal database backup The sysgalarc_mm-dd-yyyy_hh_mm_am.bak file = the SysGal Archive backup Page 17 of 23

23 Section-5 Modifying your Backup Task Opening the Windows Task Scheduler You can navigate through the Windows Start Menu: Start > Settings > Control Panel > Schedule Tasks. You should see your task in the queue: Setting the Task Properties in Windows Scheduler Double-click on your task to open its properties: In the Task tab, the [Enabled] checkbox must be checked for the task to run. You change set the User Account and password to use from this screen as needed. Click Apply to save settings. Page 18 of 23

24 Setting the Schedule Properties in Windows Scheduler In the Schedule tab, you can set up the frequency for the backup task to run. Click Apply to save settings NOTE: the scheduling options will display according to whether you pick daily, weekly, etc. Once this is saved, you should be ready to perform scheduled backups, provided the related requirements are met (i.e.,server is online, proper connections are established, privileges and logins are valid, target drive is in place; etc. ). Page 19 of 23

25 Setting Task Start Path & Password in Windows Scheduler In the Task tab, you must set the Start In path by clicking the [Browse] button. When the Browse dialog screen opens, you will browse to the Backup folder you are using (whichever choice you decided, external drive, MSSQL\Backup, or the SG Backup directory). You should see the files you just made with your test run in that folder. Click OK when you have located your backup folder to close the Browse dialog screen. You will be returned to the Task Properties screen (shown below). The Start In field will now display your path in quotation marks. Click the [Set Password ] field and provide a valid password for the user account assigned to running this task. Click OK to save password. Click Apply/OK on the Task tab to save all changes. Note you can test your task by changing the start time just to kick it off. Then check for the new files in your backup folder. REMEMBER to reset your task start time back to the time you really need it to run. Page 20 of 23

26 Section-6 Automating the backup of other SG Files This section covers automating the backup of other System Galaxy files. Creating the Backup Batch Files for each SG folder 1. Create a separate Backup Batch File for each folder you want to back up (i.e. Fingerprints, Badging photos, Graphics, Icons, Reports, Logfiles, etc.) You must use the correct pathnames/foldernames for your source files. The examples below are based on a typical install where System Galaxy is located on the C drive in Program Files folder. You must use the correct pathnames/foldernames for your target folders. The examples below are based on a typical install where System Galaxy is located on the C drive in Program Files folder. You must use correct syntax for the batch file to work properly. See examples below. Example 1: Backup Batch File for Audio files (1) XCOPY "C:\Program Files\System Galaxy\Audio\*.*" "D:\Audio\" /s /y /d (1, 2) Example 2: Backup Batch File for Badging Photos XCOPY "C:\Program Files\System Galaxy\Badging\*.*" "D:\Badging\" /s /y /d Example 3: Backup Batch File for Graphics (1) XCOPY "C:\Program Files\System Galaxy\Graphics\*.*" "D:\Graphics\" /s /y /d Example 4: Backup Batch File for Icons (1) XCOPY "C:\Program Files\System Galaxy\Icons\*.*" "D:\Icons\" /s /y /d (1, 2) Example 5: Backup Batch File for Reports XCOPY "C:\Program Files\System Galaxy\Reports\*.*" "D:\Reports\" /s /y /d (1, 2) Example 6: Backup Batch File for Sagem Fingerprint templates XCOPY "C:\Program Files\System Galaxy\SagemMA\*.*" "D:\SagemMA\" /s /y /d NOTE: you can backup your log files folder if you choose or other folders at your discretion. 1 you must the /y switch to bypass the overwrite prompt failure to include this switch will cause the scheduled task to hang up and be unable to complete.; 2 you must use the /s switch to ensure the subfolders and contents are copied. It is best to always use the /s switch just in case you have added a subfolder that was not a part of your default install. NOTICE! you must include a single space only where a space should exist in the command line A) between the XCOPY command and the source file path B) between source file path and the target path C) within any folder names (e.g. System Galaxy or Program Files, etc.) D) before each switch NOTICE! you must enclose the source and target paths in quotation marks. NOTICE! you must use the *.* parameter in the source path to copy all files. Page 21 of 23

27 Breakdown of command line syntax XCOPY the DOS command that copies the files "C:\Program Files\System Galaxy\Badging\*.*" the default drive and path for the source files (i.e. where to copy files from). You must put the path inside quotation marks. You must specify a valid drive and correct path. You must use the *.* parameter to get all the files. "D:\badging\" You must put the path inside quotation marks. You must specify a valid drive and correct path. an example of a path for the target folder (i.e where to copy files into. You will use the correct drive and path for your target. /s /y /d Switches extend specific instructions to the XCOPY command. /s= Copies folders and subfolders except empty ones. /y=overwrites existing files without prompting you. (this is needed if you are scheduling the batch file using Windows Task Scheduler) /d=copies only the files that are newer then what exist in the destination folder (this keeps your backups as small as possible) Creating the Scheduled Task for the Backup Batch Files You will create a separate Scheduled Task for each Backup Batch File. Simply browse to your Windows Task Scheduler and manually add the task REMEMBER: TEST your Tasks and verify that you saved all the files you want to. REMEMBER: allow for enough time for each backup to completed before starting the next task. Page 22 of 23

28 Section-7 Restoring the Backup Files Restoring the backup database files will be done using the MSSQL Server 2005 Management Studio Program. IMPORTANT: you must stop all GCS Services and shut down all copies of the System Galaxy application before you can restore a database. NOTICE: you cannot have the old database attached when trying to do a restore function. NOTICE: depending on where you located your database (i.e. external drive, etc.), you may need to move the backups to the MSSQL\Backup folder in your SQL Server directory in order to restore it. The typical path is C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup. NOTICE: you may need to create a backup device in SQL Management Studio in order to run the restore function. Right-click Server Objects> New> Backup Device to create a new backup device. To open the Management Studio by clicking Start > Programs > Microsoft SQL Server 2005 > SQL Server 2005 Management Studio Express. To restore the database, right-click Databases> Restore files and file groups Set the To Database field and Select the From Database (source) {or pick From Device and click [ ] to browse to your device). Choose the device and click OK to run the restore. Page 23 of 23