Backup and Restore Utility For RSView 4.0 or FactoryTalk View 5 PDF

18/12/13 30310 Backup and Restore Utility for RSView 4.0 or FactoryTalk View 5.
0 HMI Server
https://rockwellautomation.custhelp.com/app/answers/detail/a_id/30310 1/11
Rockwell Automation Support Center
30310 - Backup and Restore Utility for RSView 4.0 or FactoryTalk View 5.0 HMI
Server
Access Level: TechConnect
Date Created: 11/29/2004 12:00 AM
Last Updated: 07/01/2013 07:50 AM
Question
In RSView 4.0 or FactoryTalk View 5.0, how do I use the Backup and Restore Utility for the HMI Server?
Answer
This document provides detailed information on the HMI Backup and Restore Utility. Previously, a .pdf file that contained the instructions for this utility was attached to this
AID. The instructions are now incorporated into this document. The actual downloadable files for this utility are still attached as a zip file below.
1.0 Revisions
2.0 Known Issues
3.0 Overview of the HMI Backup and Restore Utility
3.1 Installing the HMI Backup and Restore Utility
3.2 Using HMI Backup and Restore Utility with FactoryTalk View SE Version 5.1 CPR9 SR2 and Later Versions
3.3 Testing the HMI Server Backup and Restore Utility
4.0 Use, Benefits and Guidelines for the Utility
4.1 Register the Rockwell HMI Backup Server Process
4.2 Delete the Rockwell HMI Backup Server Service
5.0 Backing-up an HMI Project (Using the HMIBackupRestore Utility)
5.1 Selecting an HMI Server
5.2 Selecting the Destination Path
5.3 Starting the Back-Up Operation
6.0 Restoring an HMI Project
6.1 Running the Utility via Command Prompt
7.0 HMIBackup CFG Parameter File Structure
7.1 Path for HMIServerName Key Word Value
7.2 Default Path
7.3 Customized Path
7.4 Overwrite Warning Setting
7.5 Exclude Datalog Setting
8.0 HMIRestore CFG Parameter File Structure
8.1 CFG File Format
8.2 Default or Customized Path Location
8.3 Default Path
8.4 Customized Path
9.0 After the Restore Is Complete
9.1 Log Files
10.0 Known Issues
1.0 Revisions
01/05/09 Help PDF document updated to identify new issue with HMI Project default path location (section 6.3). See Known Issues item # 8 below.
11/15/05 Utility updated to version 1.0.0.8: Functionality added to optionally exclude data log file sets.
08/03/05 Utility updated to version 1.0.0.7: Fixes issues #6, and #7 listed below.
05/24/05 Utility updated to version 1.0.0.5: Fixes issues #1, #2 and #3 listed below.
01/28/05 Utility updated to version 1.0.0.3: Functionality added to provide warning if a backup copy already exists at selected destination.
Return to Top
2.0 Known Issues
1. Fixed: Ensure the utility folder HMIBackup is installed to a path that does NOT include any spaces in the pathname.
Installing the utility folder as a sub-folder within the "C:\Program Files" or the Desktop ("C:\Documents and settings\Username\Desktop") folder will result in errors
"The system cannot find the file specified." to appear in the LocalSystem DOS Window.
A space in the installed path will create a Tag.DB file size of ~201KB in the back up project folder (signifying an empty tag database). This issue is fixed in version
1.0.0.5 - the install pathname for the HMIBackupRestore utility can include spaces.
2. Fixed: Ensure that the backup utility does not backup to a mapped drive location. If a mapped drive location is specified, running the backup will result in a Runtime
SQL dialog with error "unable to start specified database ".
The utility will continue to completion in the background and report a successful backup, however the utility will not remove (clean-up) temp files created in the utility's
product folder (these temp files if not removed can interfere with the backup process the next time the utility is used), nor will the LocalSystem DOS Window
18/12/13 30310 Backup and Restore Utility for RSView 4.0 or FactoryTalk View 5.0 HMI Server
automatically close.
Files left in the utility product folder will include:
10 temp database DAT files
rtsql.exe
reload.sql
This issue is fixed in version 1.0.0.5 - the backup utility can backup to a mapped drive.
3. Fixed: The HMIRestore.CFG file used for restoring a backup copy includes a typo error that if corrected will cause the restore function to fail. Specifically, the source
key is defined as "SoureHMIServerpathName" (note the missing c in source).
If the spelling is corrected, the log file will indicate that the .sed file could not be found. This issue is fixed in version 1.0.0.5 - if using cfg files configured with utility
version 1.0.0.3 or earlier, ensure cfg files refer to the correct key name ("SoucreHMIServerpathName").
4. When restoring a backup HMI project, the destination pathname must include the full pathname to the SED file. If a destination giving only the project folder name is
specified, all HMI sub-components will be copied directly to the HMI Projects folder.
5. The HMIBackup utility is not able to make a backup of a remote running HMI server (that is, it is running on a remote machine). The utility must be run on the same
machine as the running HMI server.
6. Fixed: The HMIBackup utility requires that ViewStudio be installed on the same machine as the HMI server. If ViewStudio is not installed, the utility will display error
dialog "rtsql.exe can not be found in the RSViewSE installation path." even though this file is correctly installed.
This issue is fixed in version 1.0.0.7 - ViewStudio does NOT need to be installed on the HMI server machine.
7. Fixed: The HMIBackup utility requires a user to be logged in to run. This issue is fixed in version 1.0.0.7 - the backup utility can be run headless.
8. When defining the default HMI Project path in the HMIBackup CFG parameter file, the full pathname to the project's SED file may be necessary (as per the customized
path method). See PDF section 6.3.
Return to Top
3.0 Overview of the HMI Backup and Restore Utility
This HMI Backup and Restore Utility provides a means to backup and/or restore any HMI server run in a distributed SE application. The utility provides a simple graphic
user interface that follows a step-by-step process to backup or restore a server.
This utility also supports Command Line operation when used with user configurable (CFG) parameter files to allow for automated backup operation.
This utility replaces an earlier DOS-based BATCH file utility that required extensive modifications to work in a customized environment and was difficult to troubleshoot. Link
to the earlier DOS version utility, described in AID 26702 - RSView SE - How to backup a loaded HMI server using the HMIBackup Bat Utility.
Return to Top
3.1 Installing the HMI Backup and Restore Utility
1. Uninstall (delete) any previous version of this utility from your hard drive.
2. Unzip the attached file HMIBackupRestoreUtility.zip to any path location on your hard drive. Note that all files must be installed to the same directory folder.
3. The utility is dependant on component "Rockwell HMI Backup Server.exe" running as a service. Register this service as follows:
Open the DOS cmd prompt.
Navigate to the utility's directory location.
Enter command including quotes. Note: For some o/s, it may be necessary to include the full pathname:
"Rockwell HMI Backup Server.exe" /service.
4. Download the attached file HMIBackupRestoreHelp.pdf to any path location on your hard drive.
This file includes the utility's Help document, which provides a step-by-step configuration and usage description.
Return to Top
3.2 Using HMI Backup and Restore Utility with FactoryTalk View SE Version 5.1 CPR9 SR2 and Later Versions
The latest version of the Backup and Restore Utility for HMI Servers is included as part of the overall FactoryTalk View SE HMI product installation since version 5.1 CPR9
SR2 and later. You can launch the utility from the following path:
Start-->All Programs-->Rockwell Software-->FactoryTalk View-->Tools-->HMI Server Backup and Restore
You could have more than one version of the HMI Server Backup and Restore utility installed. This could occur:
Because of an HMI product upgrade where this utility was previously installed.
Because someone installed the version attached to this Answer ID, not realizing it was already installed with the newer HMI product installation.
The utility is dependant on the component ."Rockwell HMI Backup Server.exe" running as a service.
You can also see 551185 - Alarm.tpl cannot be found in the RSView installation path
Do the following to ensure the version that was installed with the HMI product is the version currently running as a service on the computer.
1. Click the Windows Start button.
2. Select Run to display a Command Line.
3. At the prompt, type the following path:
/command
4. Click OK.
5. Type the following, including the quotation marks (because there are spaces in the path):
"C:\Program Files\Rockwell Software\RSView Enterprise\Rockwell HMI Backup Server.exe" /service
After pressing OK, it will be successful if no popup window appears to indicate any type of problem:
Delete the folder that contains the files for the files from this Answer ID.
Never delete any files located in the directory below:
C:\Program Files\Rockwell Software\RSView Enterprise\
Return to Top
3.3 Testing the HMI Server Backup and Restore Utility
You can test the HMI Server Backup and Restore utility by using it to backup an HMI Server that is loaded and in use on the computer.
An HMI Server that is in use will have a locked Tag database. After using the utility, look at the backed up HMI Server project to see that all the folders and files are there.
Final confirmation is to look at the Tag database file in the Tag folder (*.DB) and check the size of the file. If the file size is 201KB, then the Tag database is empty and it is
likely that the Rockwell HMI Backup Server.exe is not running as a service.
Return to Top

4.0 Use, Benefits and Guidelines for the Utility
The HMI Backup and Restore Utility was developed to provide the ability to backup a running HMI server's project components. The backup copy can be targeted to a
destination path local (on same machine) to the utility or to a mapped drive (to a remote machine).
Keep the following in mind:
The HMI Backup and Restore Utility should be run on the same machine as the intended HMI server.
To backup a project, the utility must run on the same machine as the running HMI server (the source project).
To restore a project, the utility should be run on the intended machine that will host the HMI server (the target project). Be aware that the restore procedure can only be
used when the HMI Server is not running.
When an HMI server is running, the HMI tag database files are locked and cannot to be copied by other backup utilities.
The HMIBackupRestore utility uses the process DbUnload.exe to unload data from the locked database files, and process rtsql.exe to reload this data to the
database backup files. These supporting processes (DbUnload.exe and rtsql.exe) are installed as part of the RSView SE HMI server installation.
To run, this utility requires, as a minimum, that the RSView SE HMI server component be installed on the same machine.
This utility can also be run from the DOS command prompt (or from a BAT file) when run with a parameter configuration (CFG) file.
You can include or exclude data log filesets should these files be stored to a path within the HMI project. A checkbox to exclude these files is provided on the main
HMIBackup dialog. When running the utility from the CMD prompt, the HMIBackup.CFG file can also be configured to exclude the data log files.
To support remote backup functionality, the utility uses a server component that must be run as a service. Running as a service, no user login is required. This allows
the utility to run headless.
The utility also provides a restore functionality that can be used to restore an HMI server, provided the server is not running. If the HMI server is running, the database
is locked and cannot overwritten by this utility.
This utility can be installed to any path location (pathname can include spaces). However, all executable files for this utility (HMIBackupRestore.exe, "Rockwell HMI
Backup Server.exe" and ReloadMain.sql) must be co-located.
The configuration parameter CFG files can be located at any path location.
When running, this utility will look for and copy the following files:
Alarm.tpl
Tags.tpl
DbUnload.exe
Rtsql.exe
The above should all have been installed by SE.
Return to Top
4.1 Register the Rockwell HMI Backup Server Process
Once located to the desired path location, register the process "Rockwell HMI Backup Server.exe" as a service as follows:
1. Open the DOS cmd prompt and navigate to the correct directory location.
2. Enter the command (including quotes) as follows:
"Rockwell HMI Backup Server.exe" /service
Return to Top
4.2 Delete the Rockwell HMI Backup Server Service
To delete this service, using the cmd prompt to issue the following command:
"Rockwell HMI Backup Server.exe" /unregserver
Return to Top

5.0 Backing-up an HMI Project (Using the HMIBackupRestore Utility)
To back-up an HMI project:
1. To launch the utility, run or double-click HMIBackupRestore.exe.
The first user interface is comprised of three button selections, as shown in Figure 1.
Figure 1: Main frame to select operation
2. To open the HMI Server Backup Interface, click the first button, Backup HMI Server.
The HMI Server Backup opens, as shown in Figure 2. This interface is comprised of seven controls:
two edit boxes
two browse buttons
a checkbox
a start button
a cancel button
Figure 2: Main HMI Server Backup Interface
Return to Top
5.1 Selecting an HMI Server
1. Use the top edit box (shown above, in Figure 2) to identify the source HMI server for the backup operation.
2. Enter the full pathname of the HMI server's SED file (<ProjectName>.sed), or browse to and select the project SED file.
3. Click on the source Browse button to open the dialog shown at Figure 3.
Figure 3: Selecting the source HMI Server project
Figure 3 will open to the default HMI Project folder:
Assuming a default installation, the path is as follows:
C:\Documents and Settings\All Users\Documents\RSView Enterprise\SE\HMI Projects
4. Navigate to and select the SED filename to complete the selection process. Return to Top
5.2 Selecting the Destination Path
1. To specify the backup storage path, use the bottom edit box (in Figure 2). Enter the full pathname, or use the related Browse button to select the desired path location.
2. Click on the Browse button to open the dialog shown at Figure 4.
Figure 4: Selecting the backup destination directory
As shown in Figure 4, the default destination is the root "C:\ " directory.
3. Navigate to and select the desired destination directory.
Alternately, you can create a new folder in this dialog.
4. Once you select the destination path, the main dialog returns to.
If desired, use the provided Checkbox to exclude any Data Log filesets contained within the project.
The HMI Server Backup dialog should now look similar to Figure 5.
Figure 5: Ready to start backup HMI Server project
Return to Top
5.3 Starting the Back-Up Operation
Depending on the size of the tag database, this process will require time to complete. The utility will advise when the backup process is complete.
After selecting the source's project SED filename and the destination pathname, complete the following:
1. Click the Start Backup button to begin the backup process.
A warning dialog per Figure 6 may open if an HMI project with the same name already exists at the backup destination.
Figure 6: Overwrite warning dialog
2. You can respond to the warning that an existing file has the same name by doing one of the following:
Click Yes if you want to overwrite the older copy. Continue to Step 3.
Click No to exit from the backup.
A backup progress dialog will open, per Figure 7. This dialog also provides the option to cancel the backup operation.
Figure 7: Backup progress dialog
Note: When backing up an HMI server to a remote machine (using a mapped drive), the time required for completing the backup will be longer. Wait for the HMI
Server Backup Complete dialog to open. For a tag database of approximately 6K tags, the time required to complete a backup will be approximately 2 minutes.
3. If no errors are encountered by the utility, the Backup Complete dialog will open, per Figure 8.
Figure 8: HMI Server backup complete dialog
Return to Top

6.0 Restoring an HMI Project
1. The main utility window is shown below:
2. Click the Restore HMI Server button, shown above, to open the HMI Server Restore dialog. This interface is similar to Figure 9 below.
Figure 9: Restore HMI Sever dialog
3. To identify the HMI project to backup, into the top edit box titled Source HMI Server Path, type the full pathname of the SED file.
If you don't know the path, you can use the Browse button to locate and select the SED file you want.
Clicking Browse opens the Select Source HMI Server Project dialog, as shown below:
Figure 10: Browsing to select a source HMI Server project (*.sed)
After you select the file path of the SED file to restore, the HMI Server Restore dialog returns.
4. To select the destination HMI Server, use the bottom edit box to specify the path destination for the selected HMI server (target server). Enter the full pathname or use
the Browse button to navigate to the HMI project's SED filename, per Figure 11.
As in the previous step, selecting Browse opens another window that allows you to navigate, locate and select the location for the restored file.
Figure 11: Selecting the HMI Server project destination
Caution! The SED pathname above should include the full pathname. Failure to include the full path may result in HMI project sub-components being copied directly
into the HMI Project folder.
5. After selecting the source and target HMI server project locations, the main interface utility should look like Figure 12.
Figure 12: Start to restore HMI Server project
6. Click the Start Restore button to start the procedure. Note that the HMI server must be-stopped before this process can proceed.
A progress dialog for the restore process will be shown, per Figure 13.
Figure 13: Restore progress dialog
If no errors are encountered, once the restore procedure is finished, the Restore Complete dialog will open, as shown in Figure 14.
Figure 14: Restore Complete dialog
7. Click OK. The Restore is complete.
Return to Top
6.1 Running the Utility via Command Prompt
1. Open the DOS command prompt.
2. Change the directory (cd) to the HMIBackupRestore.exe file location.
3. Enter the following command syntax (also shown in Figure 15). For example:
For the backup function, enter HMIBackupRestore.exe /b HMIBackup.cfg
For the restore function, enter HMIBackupRestore.exe /r HMIRestore.cfg
4. Parsing the DOS command
HMIBackupRestore.exe is the executable file for this utility.
In the example above, the exe file path is "C:\HMIBackup\";
The /b (or /B): flag indicate whether the Backup or the Restore operation is active:
/b for backup
/r for restore).
HMIBackup.CFG - parameter file, described below.
Note that quotation marks are not required. If restoring a project, the HMIRestore.CFG file would be used.
If the command is not entered in the correct format, a prompt dialog as shown in Figure 16 will open.
Return to Top

7.0 HMIBackup CFG Parameter File Structure
The CFG file can be customized to suit local requirements. The file's format must be similar to the following:
[HMIServerParameters]
HMIServerName=Waste Water Project
DestinationPath=C:\projects
ShowOverwriteWarning=N
ExcludeDatalog=Y
Return to Top
7.1 Path for HMIServerName Key Word Value
The HMIServerName key word value can be configured using either the:
Default path
Customized path
Return to Top
7.2 Default Path
HMI Project default path location need only specify the HMI server name (the utility will find the server automatically).
For example, HMIServerName= Waste Water Project
Return to Top
7.3 Customized Path
If the default path location does not work, you must use the full customized path method listed below.
Customized Path: identify the full pathname to the server's SED file.
The string value must be entered all on one line. For example:
HMIServerName="F:\Common Documents\RSView Enterprise\SE\HMIProjects\Core\Core.sed"
The DestinationPath key word value should be configured to the full pathname. Return to Top
7.4 Overwrite Warning Setting
The ShowOverwriteWarning key word is used to configure whether the overwrite warning dialog is to be enabled.
Y value (or if this key does not exist) will enable the warning dialog.
Entering N value (for No) will disable the warning dialog.
For automated backups, this key should be set to N. Return to Top
7.5 Exclude Datalog Setting
The ExcludeDatalog key word is used to configure whether the datalog filesets should be excluded.
Y value excludes these files.
N value (or if key is missing) will backup any datalog filesets if any exist within the HMI project path hierarchy.
Return to Top

8.0 HMIRestore CFG Parameter File Structure
The CFG file can be customized to suit local requirements. Return to Top
8.1 CFG File Format
The file's format must be:
[RestoreHMIServerParameters]
SourceHMIServerpathName=C:\WasteWaterProject\WasteWaterProject.sed
File Attachments
DestinationHMIServer=WasteWater Project.sed
Set the SourceHMIServerpathName key word value to the full pathname of the backup HMI project's SED file. Return to Top
8.2 Default or Customized Path Location
The DestinationHMIServer key word value can be configured using either the:
Default path
Or
Customized path
Return to Top
8.3 Default Path
HMI Project default path location: need only specify the HMI server name (with the SED extension).
The utility will find the server automatically, for example, HMIServerName= Waste Water Project.sed Return to Top
8.4 Customized Path
Enter the full pathname to the server's SED file. Note that the string value must all be entered on one line. For example:
DestinationHMIServer ="F:\srvdata\Common Documents\RSView Enterprise\SE\HMIProjects\ Core\ Core.sed"
Caution! Specify the full SED file pathname.
If the applicable CFG file is located at a different path location than the EXE files, the parameter must include the full pathname. For example, if a CFG file is at the root C:\,
enter the following:
HMIBackupRestore.exe /b C:\ HMIBackup.CFG
Note that CFG filenames can be customized to any name. Return to Top
9.0 After the Restore Process is Complete
After the backup process is complete, a backup folder with the same project name as the source HMI Server is created in the destination directory. This folder will include
all the HMI server's sub-components.
All HMI server components will be overwritten with the components from the backup HMI project.
If the original (target) HMI server includes components that no longer exist in the backup copy, these components will not be deleted from the target HMI project destination.
Return to Top
9.1 Log Files
Log files "HMIBackup.log" or "HMIRestore.log" as applicable will be written to the HMIBackupRestore.exe directory location detailing execution information including any
errors. Return to Top
10.0 Known Issues when Restoring
When restoring a backup HMI project, the destination pathname must include the full pathname up to and including the SED filename. If a destination is specified giving
only the project folder name, the HMI sub-components will be copied directly into the HMI Projects folder.
The HMIBackup utility is unable to make a backup copy of a remote HMI server (meaning, the utility must run locally to the server).
The HMIBackup utility will function correctly regardless of whether the HMI server is running. However, for the HMIRestore utility to function correctly, the HMI server must be-
stopped.
There has been a case where the "HMI Project" default path location in section did not work. In this case, you must use the Customized Path method.
Return to Top
HMIBackupRestoreUtility.zip (58.62 KB)
Comments (0)
This answer has no comments
Post a Comment
Product Tree for This Answer (expand/collapse)

DISCLAIMER
This knowledge base web site is intended to provide general technical information on a particular subject or subjects and is not an exhaustive treatment of such subjects.
Accordingly, the information in this web site is not intended to constitute application, design, software or other professional engineering advice or services. Before making
any decision or taking any action, which might affect your equipment, you should consult a qualified professional advisor.
ROCKWELL AUTOMATION DOES NOT WARRANT THE COMPLETENESS, TIMELINESS OR ACCURACY OF ANY OF THE DATA CONTAINED IN THIS WEB SITE AND MAY
MAKE CHANGES THERETO AT ANY TIME IN ITS SOLE DISCRETION WITHOUT NOTICE. FURTHER, ALL INFORMATION CONVEYED HEREBY IS PROVIDED TO USERS
"AS IS." IN NO EVENT SHALL ROCKWELL BE LIABLE FOR ANY DAMAGES OF ANY KIND INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS
PROFIT OR DAMAGE, EVEN IF ROCKWELL AUTOMATION HAVE BEEN ADVISED ON THE POSSIBILITY OF SUCH DAMAGES.
ROCKWELL AUTOMATION DISCLAIMS ALL WARRANTIES WHETHER EXPRESSED OR IMPLIED IN RESPECT OF THE INFORMATION (INCLUDING SOFTWARE)
PROVIDED HEREBY, INCLUDING THE IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, AND NON-INFRINGEMENT. Note that
certain jurisdictions do not countenance the exclusion of implied warranties; thus, this disclaimer may not apply to you.
This page is best viewed in Internet Explorer 7, Firefox 3.5, Chrome 4, Safari 4 or newer.

Backup and Restore Utility For RSView 4.0 or FactoryTalk View 5 PDF

Transféré par

Informations du document

Description originale:

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Backup and Restore Utility For RSView 4.0 or FactoryTalk View 5 PDF

Transféré par

Droits d'auteur :

Formats disponibles

18/12/13 30310 Backup and Restore Utility for RSView 4.0 or FactoryTalk View 5.

Vous aimerez peut-être aussi