OpenEnterprise Version 3x Upgrade Guide D301827X012 July 2018

Transcription

1 OpenEnterprise Version 3x Upgrade Guide Remote Automation Solutions

2 System Training A well-trained workforce is critical to the success of your operation. Knowing how to correctly install, configure, program, calibrate, and trouble-shoot your Emerson equipment provides your engineers and technicians with the skills and confidence to optimize your investment. Remote Automation Solutions offers a variety of ways for your personnel to acquire essential system expertise. Our full-time professional instructors can conduct classroom training at several of our corporate offices, at your site, or even at your regional Emerson office. You can also receive the same quality training via our live, interactive Emerson Virtual Classroom and save on travel costs. For our complete schedule and further information, contact the Remote Automation Solutions Training Department at or us at education@emerson.com. ii Contents

3 Contents OpenEnterprise Version 3x Upgrade Guide 1 Overview Upgrading the Server Create the Folders for the 2.83 Files Perform Pre-upgrade Activities Copy Files from the 2.83 Server to the 3.2x Server Address Systems Without ROC Tables Run the Upgrade Utility Perform Post-Upgrade Activities Executing the Time Zone SQL Script Adjusting File Transfer Server Settings Upgrading Systems with Multiple Databases Upgrading a Redundant Server Upgrading a Workstation Create the Folders for the 2.83 Files Copy Files from the 2.83 to the 3.2 Workstation Run the Upgrade Utility Modifying Program IDs Renaming OEToolBox Tokens Forward and Backward Compatibilities Upgrading Standalone Reporting Upgrade the Reporting Templates Create the Folders for the 2.83 Files Copy Files from the 2.83 Machine to the 3.2x Machine Run the Upgrade Utility Adjust File Transfer and Server Settings MIgrate the OE Reporting Add-In Upgrading Standalone Messaging Create the Folders for the 2.83 Files Contents iii

4 5.2 Copy Files from the 2.83 Machine to the 3.2x Machine Run the Upgrade Utility Start the OpenEnterprise Session Upgrading Standalone ODBC Appendix A. Troubleshooting Tips Errors Related to the ROC.MDB version Errors Related to Missing Default OpenEnterprise User Groups Error Related to SQL Error Related to Missing ROC Schema Error Related to Database Not Starting Error Related to Missing Parameter Error Related to Unsupported Version Error Related to Script Not Running as Administrator Errors Related to Upgrade Folder Missing Error Related to Creating Folders Error Related to Registry Read CreateUpgradeFolder.cmd Error Related to Stopping the OpenEnterprise Service Error Related to Missing (or Higher) Database (Data Folder) Error Related to Registry Read UpgradeServer.cmd Errors Related to Missing Files (File Validation) Error Related to Schema Upgrade Error Related to NetView to SQL Export Error Related to Harvester to SQL Export Error Related to OpenEnterprise.ini File Validation Error Related to Stopping the OpenEnterprise Service Error Related to OpenEnterprise.ini File Validation Appendix B. Pre-upgrade Poly.cfg File iv Contents

5 1 Overview OpenEnterprise Version 3x Upgrade Guide CAUTION This guide assumes you have the relevant OpenEnterprise systems administration experience to perform this task. If you do not, contact your Emerson Automation Solutions LBP or the Remote Automation Solutions Life Cycle Services Group for assistance. Additionally, you must also login as the local domain administrator to successfully install the OpenEnterprise components. OpenEnterprise 3.2x supports upgrading from OpenEnterprise 2.83 systems using a side-by-side upgrade, in which you first install a fresh copy of OpenEnterprise 3.2 and Service Pack 5 (SP5) or later on a new machine and then transfer the existing application files from the OpenEnterprise 2.83 machine onto the 3.2x machine. Note For this manual, OpenEnterprise 3.2x or the 3.2x machine refers to Version (or higher). Also, OpenEnterprise 2.83 refers to Version 2.83 software build 37. You must be on build 37 to successfully upgrade. This manual discusses the following upgrades: Server (see Chapter 2) Workstation (see Chapter 3) Standalone Reporting (see Chapter 4) Standalone Messaging (see Chapter 5) Standalone ODBC (see Chapter 6) This manual, the OpenEnterprise Version 3x Upgrade Guide, details the processes required to prepare for the upgrade and the steps involved. This manual contains the following chapters: Chapter Chapter 2 Upgrading the Server Chapter 3 Upgrading the Workstation Chapter 4 Upgrading Standalone Reporting Chapter 5 Upgrading Standalone Messaging Chapter 6 Upgrading Standalone ODBC Appendix A Description Describes the process for upgrading the server. Describes the process for upgrading the workstation. Describes the process for upgrading Standalone Reporting and the Reporting templates. Describes the process for upgrading Standalone Messaging. Describes the process for upgrading Standalone ODBC. Details common troubleshooting error messages and how to resolve them. Overview 1

6 Chapter Appendix B Description Provides an example of a Poly.cfg file. This manual is just one of several manuals describing how to use OpenEnterprise. However, you should always refer to the extensive online help provided with the OpenEnterprise software. The OpenEnterprise online help is the most current and the primary source of information on effectively managing OpenEnterprise, and provides point-of-use information you can access while using OpenEnterprise. Note For information on installing OpenEnterprise, refer to the OpenEnterprise Version 3x Installation Guide (D301762X012). A clear understanding of the scale, size, and scope of your application, as well as the roles the various machines play in that process, is essential to a successful upgrade. Review this guide in its entirety before beginning the upgrade. It is recommended to test the upgrade on systems in an offline mode first. As a precautionary measure, keep the 2.83 system until you have proven the new 3.2x system to be operational. Note There may be functionality from OpenEnterprise 2.83 that has not been migrated to the 3.2x system. Refer to the Release Notes document that accompanies each release for a list of exceptions (as applicable). 2 Overview

7 2 Upgrading the Server OpenEnterprise Version 3x Upgrade Guide This chapter details the processes involved in moving the contents of an OpenEnterprise 2.83 server to an OpenEnterprise 3.2x server. Caution Data loss may occur during the upgrade. To minimize this risk, back up the following folders and/or files: Data folder History Setting Editor Export file (OpenEnterprise.ini) Custom folder BIN folder OpenBSI folder (.ndf,.zwt, etc. files) Reports folder OEStore folder Prior to the migration, you must: Install OpenEnterprise 3.2 Server and service pack 5 (or higher) on a new machine. (This becomes the 3.2x server.) Stop the OpenEnterprise session on the 2.83 server o Stop Harvester o Verify that the Converter has processed all Harvester data (UOI) files o Stop the OpenEnterprise session o Stop Netview/OpenBSI Stop the OpenEnterprise session (if applicable) on the 3.2x server. To summarize the upgrade activities: 1. Run CreateUpgradeFolders.cmd (on the 3.2x server) to create the temporary folders required during the upgrade process. 2. Perform any pre-upgrade activities. 3. Copy relevant files from the 2.83 server to the 3.2x server. 4. Address systems (if applicable) without ROC tables. 5. Run UpgradeServer.cmd (select Run as administrator). 6. Perform any post upgrade customizations. 7. Manually copy the database from the Build folder to the Data folder. Note If you are using a non-standard database location (other than the Data folder) you must update the DATA parameter in the session.config file to reflect that non-standard location. Upgrading the Server 3

8 8. Execute the TimeZone SQL script. 9. Adjust file transfer server settings. 10. Upgrade (if applicable) systems with multiple databases. 11. Upgrade (if applicable) a redundant server. 12. Start the OpenEnterprise session. The following sections describe each of these steps in detail. 4 Upgrading the Server

9 2.1 Create the Folders for the 2.83 Files OpenEnterprise Version 3x Upgrade Guide To create the folders on the 3.2x server to hold the files from the 2.83 server, run the Windows command file CreateUpgradeFolders.cmd (located in the folder C:\ProgramData\Emerson\OpenEnterprise\Upgrade) on the 3.2x server. By default, the system creates these folders in: C:\ProgramData\Emerson\OpenEnterprise\Upgrade. Important Select Run as administrator when you run this command file. The CreateUpgradeFolders.cmd file supports the following optional command line parameters: where: CreateUpgradeFolders.cmd [root] [root] is the Upgrade folder (C:\ProgramData\Emerson\OpenEnterprise\Upgrade) that holds the files copied from the 2.83 server. The following example shows the format of the CreateUpgradeFolders.cmd file to copy the 2.83 files into D:\Temp\Upgrade: CreateUpgradeFolders.cmd D:\Temp\Upgrade 2.2 Perform Pre-upgrade Activities Formatting the Poly.cfg File The Poly.cfg file (from the 2.83 server) must be in the following format: DataService defaultdb:dataservice db:defaultdb ft:db. Note Refer to Appendix B for an example of a pre-migration poly.cfg file. DataService section: This section contains the database connection settings and default areas. It requires the database data_service, default user, default access area, and plant area information. defaultdb:dataservice section: This section contains the default database settings. It specifies the database load_file, CL files and product settings. Upgrading the Server 5

10 db:defaultdb section: This section contains the project specific settings and overrides. If there are no project specific settings, then an empty section must be added. ft:db section: This section contains the fault tolerant settings. Upgrading the Report Templates on the 2.83 machine Report templates created on a 2.83 system have customizations that are incompatible with a 3.2x (or later) system. You must remove these customizations before you copy the report templates to the 3.2x server. To upgrade the templates: 1. Run the OpenEnterprise Reporting Upgrade tool OEExcelPlugInUpgrade.exe (by default, located in the OpenEnterprise install directory: C:\Program Files(x86) \Bristol\OpenEnterprise\Bin). 2. In the OpenEnterprise Reporting Upgrade tool dialog, click the Selected Folder browse button to select the folder where the report templates are located. 3. Click Convert to start the upgrade process. The status of the conversion displays in the Conversion Status pane. 4. For each report template in the selected folder, the OpenEnterprise Reporting Upgrade tool generates an upgraded.xls file and an. xls.old file. The. xls.old file is the report template file with any OpenEnterprise-specific customizations removed. 5. You must copy the. xls.old files from the 2.83 server to the corresponding report template file location on the 3.x machine so that the Report Scheduler can apply the 3.2 customizations. 2.3 Copy Files from the 2.83 Server to the 3.2x Server You can either manually copy the database and other configuration files from the 2.83 server to the 3.2x server or create a Windows command file for this purpose. (Emerson provides a sample Windows command file, ExampleCopyFrom2-83.cmd, for reference purposes only.) Copy the following content from the 2.83 server to the 3.2x server: 2.83 Data folder to C:\ProgramData\Emerson\OpenEnterprise\Upgrade\Data OpenEnterprise.ini to C:\ProgramData\Emerson\OpenEnterprise\Upgrade\OESettings 2.83 OEPing.ini to C:\ProgramData\Emerson\OpenEnterprise\Upgrade\OESettings History (log and archive files) to the same absolute folder on the 3.2x server Files related to calculation (.exe,.cmd, and.bat) to the same absolute folder on the 3.2x server Note VB calculations are not supported in 3x; do not copy these.dll files. OpenBSI Netview files to C:\ProgramData\Emerson\OpenEnterprise\Upgrade\OpenBSI 6 Upgrading the Server

11 OpenBSI Harvester files to C:\ProgramData\Emerson\OpenEnterprise\Upgrade\OpenBSI\Harvester OpenBSI configuration files to C:\ProgramData\Emerson OpenEnterprise\Upgrade\OpenBSI\CfgFiles Upgraded report template files and published reports to the same absolute folder on the 3.2x server. OEPingUpgrade_log.txt Important Before you copy any files, shut down the 2.83 server so that the system can create the current database load file (.dat) and flush all history. You copy some of these files to their final locations on the 3.2x server, while you copy others to a temporary location for the upgrade utility to process. Table 2-1 lists the files you copy to a permanent location; Table 2-2 lists the files you copy to a temporary location. Table 2-1. Server Files Copied to a Permanent Location History Files Default Location Source (2.83 Server) Target (3.2 Server) Description User defined. If you are unsure where the historical log files reside, run the following SQL query in the SQL Client: SQL> select directory, filename, archdirectory from oelogdata; directory filename archdirectory 'D:\Logfiles' 'log-4' 'F:\Online' NULL 'log-2' 'F:\EventFiles' 'D:\Logfiles' 'log-3' 'F:\Online' Query Done: 3 records selected The directory value shows the folder location of the log file. A directory of NULL indicates the log file resides in the working directory of the Database. The archdirectory value is the folder used for archive files. User-defined. The folder(s) specified in directory and archdirectory (see SQL above) must exist on the 3.2x server and are the target folder(s) for Historical log files and Archive files. Calculation Files Default Location Source (2.83 Server) Description User-defined. The path of the calculation files can be found by running the following SQL query in the SQL Client: SQL> select name, programid from calculation_table where programid NOT LIKE OEServerSideCalculator% ; name programid 'EPCALC1' 'C:\Calculations\Calc1.bat' 'EPCALC2' 'C:\Calculations\Calc2.bat' Upgrading the Server 7

12 Default Location Target (3.2 Server) Description The ProgramId value shows the file s location. User-defined. The file(s) specified in ProgramId (see SQL above) for file type calculation must exist on the 3.2x server on the same path and are the target file(s) for the calculation files. RTU Projects Default Location Source (2.83 Server) Target (3.2 Server) Description C:\ProgramData\Bristol\OpenBSI\Projects (CW projects) C:\Program Files (x86)\roclink800(roc projects) C:\ProgramData\Emerson\OpenBSI\Projects (CW projects) C:\Program Files (x86)\roclink800(roc projects) Toolbox Export Files Default Location Source (2.83 Server) Target (3.2 Server) Description C:\Users\Public\Documents\Bristol\Custom C:\Users\Public\Documents\Emerson\OpenEnterprise\Custom Published Reports Default Location Source (2.83 Server) Target (3.2 Server) Description User defined or default (C:\ProgramData\Bristol\OpenEnterprise\OEStore\Reports) User defined or default (C:\ProgramData\Emerson\OpenEnterprise\OEStore\Reports) Upgraded Report Template Files (*.xls.old) Default Location Source (2.83 Server) Target (3.2 Server) Description User defined or default (C:\Users\...Documents) User defined or default (C:\Users\Public\Documents\Emerson\OpenEnterprise\Report templates) Note Copy any published report to the same directory on the 3.2x server as it was on the 2.83 server. Files that need processing and must be copied to a temporary location on the 3.2x server include: Table 2-2. Files Copied to a Temporary Location Description Default Location Destination Subdirectory Database files OpenEnterprise settings files C:\Users\Public\Documents\Bristol\OpenEnterprise\Data (all subdirectories and files under Data folder) C:\ProgramData\Bristol\OpenEnterprise\Application Data\OpenEnterprise.ini Data283 OESettings 8 Upgrading the Server

13 Description Default Location Destination Subdirectory OEPing settings files OpenBSI files C:\ProgramData Bristol\OpenEnterprise\Application Data\OEPing.ini C:\ProgramData\Bristol\OpenBSI\current.mdb Note: If the file name in use is different from current.mdb, you must pass the file name as a command line parameter to UpgradeServer.cmd. C:\ProgramData\Bristol\OpenBSI\CfgFiles C:\ProgramData\Bristol\OpenBSI\Harvester OESettings OpenBSI OpenBSI\CfgFiles OpenBSI\Harvester As shown in Figure 2-1, you can copy these files to any user-defined root folder, with the associated files in the relevant subdirectories: Figure 2-1. Server Subdirectory Structure for Copying Files Upgrading the Server 9

14 Notes The root folder to which you copy files can be any user-defined location on the 3.2x server. The default folder is C:\ProgramData\Emerson\OpenEnterprise\Upgrade. The directory structure of the Data folder from the source 2.83 server must be preserved on the target (3.2x) server. Ensure that you copy any customer-specific CL files to the 3.2x server. 2.4 Address Systems Without ROC Tables If your OpenEnterprise 2.83 database does not have a ROC schema or ROC support, you must run the Windows command file AddRoc283.cmd after you have copied the relevant files to the 3.2x server. If your OpenEnterprise 2.83 database does have a ROC schema or ROC support, proceed to the next section, Run the Upgrade Utility. The AddRoc283 command file adds the ROC schema and required content for the ROC tables to the 2.83 database in the Data283 folder and adds any missing entries for ROC support into the poly.cfg file in the same folder. Important Select Run as Administrator when you run this command file. The AddRoc283.cmd file supports the following optional command line parameters: where: AddRoc283.cmd [root] [database load file] [root] is the Upgrade folder containing the 2.83 files (by default, C:\ProgramData\Emerson\OpenEnterprise\Upgrade). [database load file] is the name of the 2.83 database load file (by default, realtime.dat). The process reports any errors that may occur during the upgrade process to the add_roc283_log.txt file. When the upgrade completes, review the add_roc283_log.txt file for the overall status of the upgrade. If errors occurred during the schema upgrade (AddRoc283.cmd), review the add_roc283_error.txt file, located in the Data283 folder. 10 Upgrading the Server

15 2.5 Run the Upgrade Utility OpenEnterprise Version 3x Upgrade Guide Once you have copied the relevant files to the 3.2x server, run the Windows command file UpgradeServer.cmd to perform the upgrade. Important Select Run as Administrator when you run this command file. This command file processes the data copied from the 2.83 server to perform the upgrade. As part of the system upgrade, the utility: 1. Stops the OpenEnterprise session (if it is currently running). 2. Validates the files copied from the 2.83 server, checking for the presence of critical files such as the database load file (.dat file), Poly.cfg, and OpenEnterprise.ini. 3. Uses the Netview upgrade tool to convert the OpenBSI Netview configuration to a series of SQL statements for inserting RTUs and lines. 4. Directs the Harvester upgrade tool to convert the Harvester configuration to a series of SQL statements for inserting schedules and collection requests for Archives, Audits, WrapArrays, and PushdownArrays. 5. Directs the OEPing upgrade tool to upgrade the OEPing settings defined in OEPing.ini and OpenEnerprise.ini and create an OEPing.config file. 6. Validates OpenEnterprise.ini update/merge of task data and Server Security credentials. 7. Upgrades the database by running UpgradeSchema.cmd to upgrade the Data283 folder. 8. Renames the report template files (if any). The UpgradeServer.cmd file supports the following optional command line parameters: where: UpgradeServer.cmd [root] [NoPrompt] [database load file] [NetView database] [report template folder] [root] is the Upgrade folder containing the 2.83 files (by default, C:\ProgramData\Emerson\OpenEnterprise\Upgrade). [NoPrompt] suppresses a user prompt if non-critical files (such as OpenBSI files) do not exist in the Upgrade folder. By default, the command file prompts the user when missing files are detected. [database load file] is the name of the 2.83 database load file (by default, realtime.dat). [NetView database name] is the name of the 2.83 OpenBSI Netview database (.mdb) file (by default, current.mdb). [report template folder] is the folder to which the upgraded report templates from the 2.83 server are copied. You can redirect the command file to custom directories if you have used them. For example, if you have copied the 2.83 files into D:\Temp\Upgrade, use the following parameters: Upgrading the Server 11

16 UpgradeServer.cmd D:\Temp\Upgrade UpgradeServer.cmd builds the upgraded database in a temporary folder (the Build folder under the root folder provided as input (by default, C:\ProgramData\Emerson\OpenEnterprise\Upgrade\Build). The process reports any errors that occur during the upgrade process to the upgrade_server_log.txt file. When the upgrade completes, review the upgrade_server_log.txt file for the overall status of the upgrade. If errors occurred during the schema upgrade (UpgradeSchema.cmd), review the upgrade_schema_error.txt file. You can find upgrade information from the various upgrade tools in the following logs: NetViewToSQL_log.txt: logs from the Netview upgrade tool (found in the upgrade root folder). HarvesterToSQL_log.txt: logs from Harvester upgrade tool (found in the upgrade root folder). OEPingUpgrade_log.txt: logs from OEPing upgrade tool (found in the upgrade root folder). calculation_upgrade.txt: logs from calculation upgrade tool (found in the upgrade root folder\build). The upgrade procedure is repeatable. You can run the upgrade process multiple times for testing or to include any data recently added to the 2.83 database that you want to migrate to the 3.2x server. Once the upgrade finishes successfully, you must copy the upgraded database (in the Build folder) to the final folder used for the OpenEnterprise 3.2 server (by default, C:\ProgramData\Emerson\OpenEnterprise\Data. At this point, you can start the OpenEnterprise Windows service to run the OpenEnterprise Server. 2.6 Perform Post-Upgrade Activities 1. Review and re-engineer any system-specific customizations performed on the OpenEnterprise database as part of any customer-specific projects (as appropriate). 2. Reinstate any customized session configurations. 3. Restore any other project customizations 4. Change File Transfer Server Settings for reporting as explained below Executing the Time Zone SQL Script Execute the Time Zone SQL script (located in the OpenEnterprise default directory C:\ProgramData\Emerson\OpenEnterprise\Data\TimeZones). Select a SQL script based on the applicable time zone (such as CentralUS.SQL). You must connect using SQLC, log on as System, and include the file name: SQL > include C:\ProgramData\Emerson\OpenEnterprise\Data\TimeZones\UTC- 0600_Central_Time_US_&_Canada ; 12 Upgrading the Server

17 2.6.2 Adjusting File Transfer Server Settings OpenEnterprise Version 3x Upgrade Guide If the hostname of the 3.2x server is different from the hostname of the 2.83 server, you must change the file transfer server settings in the OpenEnterprise database to the hostname of the 3.2x reporting machine. To do this, use the Edit menu in the Report Configuration tool, select File Transfer Server, complete the Report Server String field, and click OK. See Figure 2-2. Figure 2-2. File Transfer Server Settings Upgrading Systems with Multiple Databases If you have servers with multiple sessions, you must upgrade each database in a separate temporary location. Run the file UpgradeServer.cmd for each database, one at a time. Important Do not run multiple instances of UpgradeServer.cmd at the same time. 1. Create the root folder for the database; start the command file CreateUpgradeFolders.cmd and specify the root folder. 2. Copy the database files for each of these databases to separate temporary locations. Start CreateUpgradeFolders.cmd and specify the root folder. 3. Provide the initialization data in the upgrade utility. 4. Perform any needed post-upgrade activities. 5. Add any custom services to the Windows Services file and perform any Windows firewall modifications. 6. Add any virus checker definitions and exclusions. Upgrading the Server 13

18 2.6.4 Upgrading a Redundant Server Configuring a Redundant Server To configure OpenEnterprise running in a redundant session, set up two servers (such as ServerA and ServerB) on each of which is installed OpenEnterprise 3.2 with Service Pack 5 (or higher) running standalone sessions. 1. Perform the upgrade process on ServerA (as detailed in Section 2.5, Run the Upgrade Utility). 2. Stop the session on ServerB. 3. Copy the following files from the upgraded ServerA Data folder History Archives Reports Scada.config Session.config OpenEnterprise.ini OEPing.config CommManager.config Follow the procedure Configuring a Redundant Session described in the OpenEnterprise online help to configure a redundant session. Upgrading a Redundant Server Configuration Follow the steps outlined below if the upgrade process is performed on an already configured redundant server. 4. Stop the OpenEnterprise service on the master and standby. 5. Perform the upgrade process on the master. 6. Copy the following files from the upgraded master to the standby server. Data folder Note The upgrade process overwrites the Data folder and the Poly.cfg file. You may need to update the Poly.cfg file to correct the ft section for the 3.2x server names. History Archives Reports Scada.config OpenEnterprise.ini OEPing.config CommManager.config 7. Restart the OpenEnterprise Service on the master and standby devices. 14 Upgrading the Server

19 3 Upgrading a Workstation OpenEnterprise Version 3x Upgrade Guide This chapter details the processes involved in migrating an OE 2.83 workstation to OE (or later) workstation. These processes include: 1. Creating the folders for the 2.83 file copy 2. Transferring files from the 2.83 workstation to the 3.2x workstation. 3. Running the upgrade utility. 4. Making program ID changes. 5. Making OEToolBox Token changes. 6. Validating forward and backward compatibility. 3.1 Create the Folders for the 2.83 Files To create the folders on the 3.2x workstation required to hold the files from the 2.83 workstation, run the Windows command file CreateUpgradeFolders.cmd (located in the folder C:\ProgramData\Emerson\OpenEnterprise\Upgrade). By default, the system creates these folders in C:\ProgramData\Emerson\OpenEnterprise\Upgrade. Important Select Run as administrator when you run this command file. The CreateUpgradeFolders.cmd file supports the following optional command line parameters: where: CreateUpgradeFolders.cmd [root] [root] is the Upgrade folder (C:\ProgramData\Emerson\OpenEnterprise\Upgrade) that holds the files copied from the 2.83 Workstation. You can modify the command file to place the files into another directory. For example, to copy the 2.83 files into D:\Temp\Upgrade, use the following run parameters: CreateUpgradeFolders.cmd D:\Temp\Upgrade 3.2 Copy Files from the 2.83 to the 3.2 Workstation You must manually copy files from the 2.83 workstation to the 3.2x workstation. You copy some of these files to their final locations on the 3.2x workstation, while you copy others to a temporary location for the upgrade utility to process. Table 3-1 lists the files you copy to a permanent location; Table 3-2 lists the files you copy to a temporary location. Table 3-1. Workstation Files Copied to a Permanent Location Description OEStore folder Default Location Source (2.83 workstation) C:\ProgramData\Bristol\OpenEnterprise Upgrading a Workstation 15

20 Description Default Location Target (3.2 workstation) C:\ProgramData\Emerson\OpenEnterprise Files that need processing and must be copied to a temporary location on the 3.2 workstation: Table 3-2. Workstation Files Copied to a Temporary Location Description Default Location Destination Subdirectory OpenEnterprise settings file C:\ProgramData\Bristol\OpenEnterprise\Application Data\OpenEnterprise.ini OESettings Note The root folder to which you can copy files can be any user-defined location on the 3.2x workstation. The default folder is C:\ProgramData\Emerson\OpenEnterprise\Upgrade. Figure 3-1. Workstation Upgrade Folder OE Store Copy the OEStore folder manually from its location on the 2.83 workstation (by default, C:\ProgramData\Bristol\OpenEnterprise\) to its final location on the 3.2x workstation (by default, C:\ProgramData\Emerson\OpenEnterprise\). Note Once saved on a 3.2x workstation, 3.2x files are not backwardly compatible with 2.83 files. OpenEnterprise.ini Copy the OpenEnterprise.ini file manually from its location on the 2.83 workstation (by default, C:\ProgramData\Emerson\OpenEnterprise\Application Data) to its temporary location on the 3.2x workstation (C:\ProgramData\Emerson\OpenEnterprise\Upgrade\OEsettings). The CreateUpgradeFolders.cmd command file created this folder. This temporary location allows the upgrade utility to change certain settings in the copied.ini file (see Run the Upgrade Utility). 16 Upgrading a Workstation

21 3.3 Run the Upgrade Utility OpenEnterprise Version 3x Upgrade Guide Once you have manually copied the relevant files to the 3.2x workstation, run the command file UpgradeWorkstation.cmd to perform the upgrade. Important Select Run as administrator when you run this command file. The command file processes the data copied from the 2.83 workstation and performs the following tasks: 1. Validates OpenEnterprise.ini 2. Modifies the Registry to support 2.83 OPC DA tags 3. Updates OpenEnterprise.ini The UpgradeWorkstation.cmd file supports the following optional command line parameters: where: UpgradeWorkstation.cmd [root] [root] is the Upgrade folder containing the 2.83 files (by default, C:\ProgramData\Emerson\OpenEnterprise\Upgrade). Note This tool logs details regarding its execution to the upgrade_workstation_log.txt file. Upgrading a Workstation 17

22 Figure 3-2. Workstation Upgrade Process Modifying Program IDs The ProgID for the OE OPC DA Server changes in the transition from version 2.83 to version 3.2x. All the OEDesktop clients work correctly with this name change except for GraphWorX. For OPC DA Tags to continue functioning within GraphWorX following the upgrade, a modification to the registry is required to route requests for the old ProgID to the new ProgID. The Workstation Upgrade Tool performs the registry modification Renaming OEToolBox Tokens OEToolbox tokens have different names in the 2.83 and 3.2x databases. You must then rename the 2.83 tokens to the 3.2x standards as part of the content upgrade process. As in 2.83, the * custom token is granted (all custom tokens) to user groups. 18 Upgrading a Workstation

23 The privileges of these custom tokens for user groups is different in 3.2x. The upgrade process automatically maps old privileges to new privileges without requiring user input. The OE Server upgrade automatically performs all token updates; no user actions are necessary as part of a workstation upgrade Forward and Backward Compatibilities Running a 2.83 Workstation with a 3.2x Server The following areas are forward-compatible Desktop Components o o o o o o o Alarm Banner Alarm View SQL View Security Config Notes Trends GraphWorX After you upgrade the server, you can upgrade workstations at any time. However, 2.83 workstations connected to a 3.2x upgraded server have usage restrictions: No alarms display in the Alarm Printer Use Administrative Tools in the 3.2 Container; do not use ToolBox.exe. Users must not change their password on the 2.83 workstation; any password changes must be performed on the 3.2x server. Running a 3.2x Workstation with a 2.8 Server Connecting a 3.2x upgraded workstation to a 2.83 server is not supported. Upgrading a Workstation 19

24 20 Upgrading a Workstation

25 OpenEnterprise Version 3X Upgrade Guide 4 Upgrading Standalone Reporting This chapter details the processes involved in upgrading Standalone Reporting from a 2.83 environment to a (or higher) environment. Prior to the migration, you must: Install OpenEnterprise 3.2 Standalone Reporting and service pack 5 (or higher) on the 3.2x machine. Stop the OpenEnterprise session on both the 2.83 and 3.2x servers (if running). To summarize the migration activities: 1. Upgrade the Reporting Template files on the 2.83 machine. 2. Run CreateUpgradeFolders.cmd on the 3.2 machine to create the temporary folders required during the migration process. 3. Copy the relevant files from the 2.83 machine to the 3.2x machine. 4. Run the UpgradeReporting.cmd (select Run as administrator). 5. Start the OpenEnterprise session. The following sections describe each of these activities in detail. 4.1 Upgrade the Reporting Templates Report templates created on a 2.83 system have customizations that are incompatible with a (or higher) system. You must remove these customizations before copying the report templates to the 3.2x machine. To upgrade the templates: 1. Run the OpenEnterprise Reporting Upgrade tool OEExcelPlugInUpgrade.exe (by default, located in the OE install directory: C:\Program Files(x86) \Bristol\OpenEnterprise\Bin). 2. In the OpenEnterprise Reporting Upgrade tool dialog, click the Selected Folder browse button to select the location of the folder for the report templates. 3. Click Convert to start the upgrade process. The status of the conversion displays in the Conversion Status pane. For each report template in the selected folder, the OpenEnterprise Reporting Upgrade tool generates an upgraded.xls file and an. xls.old file. The. xls.old file is the report template file with any OpenEnterprise-specific customizations removed. 4. You must copy the. xls.old files from the 2.83 machine to the corresponding report template file location on the 3.2x machine so that the Report Scheduler can apply the 3.2x customizations. Upgrading Standalone Reporting 21

26 4.2 Create the Folders for the 2.83 Files To create the folders on the 3.2x machine which hold the files copied from the 2.83 machine, run the Windows command file CreateUpgradeFolders.cmd (located in the folder C:\ProgramData\Emerson\OpenEnterprise\Upgrade). By default, the system creates these folders in C:\ProgramData\Emerson\OpenEnterprise\Upgrade. The CreateUpgradeFolders.cmd file supports the following optional command line parameters: where: CreateUpgradeFolders.cmd [root] [root] is the Upgrade folder (C:\ProgramData\Emerson\OpenEnterprise\Upgrade) that holds the files copied from the 2.83 workstation. You can modify the command file to place the files into another directory. For example, to copy the 2.83 files into D:\Temp\Upgrade, use the following run parameters: CreateUpgradeFolders.cmd D:\Temp\Upgrade 4.3 Copy Files from the 2.83 Machine to the 3.2x Machine Copy all relevant reporting files from the 2.83 machine to the 3.2x machine, including: Report templates Any published reports OpenEnterprise.ini Report file locations The following files need processing and must be copied to a temporary location on the 3.2 workstation: Table 4-1. Default Report File Locations (2.83 VS 3.2x) Description Default 2.83 Location Default 3.2x Location Report Templates Published Reports For Windows 7, Server 2008: C:\Users\ \Documents For Windows XP, Server 2003: C:\Documents and Settings\ \My Documents C:\ProgramData\Bristol\OpenEnterprise\ OEStore\Reports C:\Users\Public\Documents\Emerson\ OpenEnterprise\Report templates C:\ProgramData\Emerson\OpenEnterprise\ OEStore\Reports If you are using default locations, copy the files from the 2.83 machine locations to the indicated 3.2x machine locations. If you are using custom locations, copy the files to same location on the 3.2x machine. If user-defined locations are used for report files on a 2.8x system, then the files must be copied to the same location on the 3.2x machine. 22 Upgrading Standalone Reporting

27 OpenEnterprise Version 3X Upgrade Guide Note You must create the destination folders if they are not present on the 3.2x machine. OpenEnterprise.ini You must copy the OpenEnterprise.ini file to C:\ProgramData\Emerson\OpenEnterprise\Upgrade\OESettings. Table 4-2. OpenEnterprise.ini File Location (2.83 VS 3.2) Description Default 2.83 Location Destination 3.2x Subdirectory OE Settings file C:\ProgramData\Bristol\OpenEnterprise\Application Data\OpenEnterprise.ini OESettings The CreateUpgradeFolders.cmd file creates this folder. 4.4 Run the Upgrade Utility Once you have copied the relevant files to the 3.2x machine, run the command file UpgradeReporting.cmd to perform the upgrade. Important Select Run as administrator when you run this command file. The UpgradeReporting.cmd file supports the following optional command line parameters: where: UpgradeReporting.cmd [root][report template folder] [root] is the Upgrade folder containing the 2.83 files (by default, C:\ProgramData\Emerson\OpenEnterprise\Upgrade) [report template folder] is the folder containing the report template files copied from the 2.83 machine (by default, C:\Users\Public\Documents\Emerson\OpenEnterprise\Report templates). You can redirect the command file to custom directories if you have used them. For example, if you have copied the 2.83 files into D:\Temp\Upgrade and the report template files into D:\Reporting\Templates, use the following run parameters: UpgradeReporting.cmd D:\Temp\Upgrade D:\Reporting\Templates The UpgradeReporting.cmd command file performs the additional upgrade tasks: Updates server security credentials Renames the report template files (renaming all the xls.old template files in the report templates folder to.xls files. The system expects the report template files either to be in the default folder (C:\Users\Public\Documents\Emerson\OpenEnterprise\ Report templates) or (if supplied) in the folder identified in the [report template folder] command line parameter. Upgrading Standalone Reporting 23

28 The system is now ready to run. Start the OE Service. The Report Scheduler automatically adds the customizations to the template files and runs the reports. 4.5 Adjust File Transfer and Server Settings If the hostname of the 3.2x machine is different from the hostname of the 2.83 machine, then you must change the file transfer server settings in the OE database to the hostname of the 3.x reporting machine. To do this, use the Edit menu in the Report Configuration tool, select File Transfer Server, complete the Report Server String field, and click OK. See Figure 4-1. Figure 4-1. File Transfer Server Settings 4.6 MIgrate the OE Reporting Add-In OE (and later) does not support the migration of the Standalone Report Add-In installation. Consequently, you must perform either of two processes: On a new 3.2x target machine: 1. Install Microsoft Excel. 2. Install OE 3.2 Standalone Reporting and service pack 5 or higher. On the existing machine: 1. Uninstall the Standalone Report Add-In. 2. Ensure you are using a supported version of Excel. 3. Install OE 3.2 Standalone Reporting and service pack 5 or higher. Note Refer to the OpenEnterprise Version 3x Installation Guide (part D31762X012) for full instructions and the versions of Excel supported. 24 Upgrading Standalone Reporting

29 5 Upgrading Standalone Messaging This chapter details the processes involved in upgrading Standalone Messaging from a 2.83 environment to a 3.2x environment. Prior to the upgrade, you must: Install OE 3.2 Standalone Messaging and service pack 5 (or higher) on the 3.2x machine. Stop the OpenEnterprise session on the 3.2x server (if applicable). To summarize the activities involved: 1. Run CreateUpgradeFolders.cmd (on the 3.2x machine) to create the temporary folders required during the upgrade process. 2. Copy relevant files from the 2.83 machine to the 3.2x machine. 3. Run the UpgradeOEMessaging.cmd (select Run as administrator). 4. Start the OpenEnterprise session. The following sections describe each of these activities in detail. 5.1 Create the Folders for the 2.83 Files To create the folders required to hold the files copied from the 2.83 machine, run the Windows command file CreateUpgradeFolders.cmd (located in the folder C:\ProgramData\Emerson\OpenEnterprise\Upgrade). By default, the system creates these folders in C:\ProgramData\Emerson\OpenEnterprise\Upgrade. Important Select Run as administrator when you run this command file. The CreateUpgradeFolders.cmd file supports the following optional command line parameters: where: CreateUpgradeFolders.cmd [root] [root] is the Upgrade folder (C:\ProgramData\Emerson\OpenEnterprise\Upgrade) that holds the files copied from the 2.83 workstation. You can modify the command file to place the files in another directory. For example, to copy the 2.83 files into D:\Temp\Upgrade, use the following run parameters: CreateUpgradeFolders.cmd D:\Temp\Upgrade This command file creates an OE Settings folder in the above location. 5.2 Copy Files from the 2.83 Machine to the 3.2x Machine You must manually copy the OpenEnterprise.ini settings file from the 2.83 machine to the 3.2x machine. Browse through the folder C:\ProgramData\Bristol\OpenEnterprise\Application Data and copy the OpenEnterprise.ini file to a temporary location on the 3.2x machine. Upgrading Standalone Messaging 25

30 Table 5-1. OpenEnterprise.ini File Location (2.83 VS 3.2x) Description Default 2.83 Location Destination 3.2x Subdirectory OE Settings file C:\ProgramData\Bristol\OpenEnterprise\Application Data\OpenEnterprise.ini OESettings The system automatically reads keys related to the OE Messaging configuration from the 2.83 OpenEnterprise.ini file and writes them to the 3.2x file. 5.3 Run the Upgrade Utility Once you have copied the OpenEnterprise.ini file to the 3.2x machine, run the command file UpgradeOEMessaging.cmd to perform the upgrade. Important Select Run as administrator when you run this command file. The UpgradeOEMessaging.cmd file supports the following optional command line parameter: where: UpgradeReporting.cmd [root] [root] is the Upgrade folder containing the 2.83 files (by default, C:\ProgramData\Emerson\OpenEnterprise\Upgrade). You can redirect the command file to a custom directory if you have used one. For example, if you have copied the 2.83 file into D:\OESettings, use the following run parameter: UpgradeOEMessaging.cmd D:\Temp\Upgrade D:\OESettings The UpgradeOEMessagng.cmd command file perform the additional upgrade tasks: Validates 2.83 OpenEnterprise.ini file Exports messaging configuration settings and server security credentials Encrypts server security credentials in 3.2x format Imports the settings into the target 3.2 OpenEnterprise.ini file. Verify the upgrade process The system logs any errors that occur during the upgrade process to the upgrade_oemessaging_log.txt file. Review the log file to ensure the process completed successfully without any errors. 5.4 Start the OpenEnterprise Session OEMessaging is now configured on the 3.2x machine with the 2.83 settings. Start the OE Service on the 3.2x machine. 26 Upgrading Standalone Messaging

31 6 Upgrading Standalone ODBC OpenEnterprise Version 3x Upgrade Guide Usually a third-party application uses ODBC, and that application has its own specific system requirements which may not be compatible with OpenEnterprise 3.2x. Refer to the Release Notes document that accompanies each OpenEnterprise release for further details. Following are the upgrade options for the ODBC install: 1. Upgrade the same machine Uninstall OpenEnterprise 2.83 ODBC and install Standalone ODBC from the OpenEnterprise 3.2 installation DVD. 2. Migrate to a new machine Migrate the third-party application to a new computer, having installed Standalone ODBC from the OpenEnterprise 3.2 installation on it. 3. Replace files on the same machine Manually upgrade the installed ODBC DLL version by replacing polyod32.dll and polyodbc.hlp (located in the Windows\System32 folder) with the new ones (which can be taken from a system on which OpenEnterprise 3.2 is already installed). Upgrading Standalone ODBC 27

32 28 Upgrading Standalone ODBC

33 Appendix A. Troubleshooting Tips OpenEnterprise Version 3x Upgrade Guide During the upgrade process, the system reports any errors that occur to the upgrade_server_log.txt file. When the upgrade completes, review the upgrade_server_log.txt file for the overall status of the upgrade. If the system detected errors during the schema upgrade (UpgradeSchema.cmd), review the upgrade_schema_error.txt file for detailed information. Following are some common problems and procedures for resolving them: UpgradeSchema.cmd Script Errors Errors Related to the ROC.MDB version These errors can occur if the version of the 2.83 system s ROC.MDB file is greater than The system reports these errors to the upgrade_schema_error.txt file: SQLC_UPGRADE.TXT Error: rocextendedhistorysegment4pointconfiguration_table already exists Error: rocextendedhistorysegment4pointconfiguration already exists Error: Duplicate key error in index PK-dvi_region or Error: Column scanningmode already defined in this table Error: Column manualvalue already defined in this table Error: Column physicalvalue already defined in this table Solution: These errors can be safely ignored. Errors Related to Missing Default OpenEnterprise User Groups Error Related to SQL These errors can occur if the default user groups are either not present in the 2.83 database or have been deleted. The system reports these errors to the upgrade_schema_error.txt file. Error: User guests does not exist Error: User engineers does not exist Error: User operators does not exist Error: User dispatchers does not exist Solution: These errors can be safely ignored. This error can occur when one or more SQL errors were detected. The system reports this error to the upgrade_schema_error.txt file: Error: One or more SQL errors were detected Solution: Check the log file and fix the errors reported. Appendix A: Troubleshooting 29

34 Error Related to Missing ROC Schema These errors can occur if the 2.83 system does not have ROC devices in the database. The system reports these errors to the upgrade_schema_error.txt file: SQLC_UPGRADE.TXT Error: Invalid foreign key for table 'rocversion' or Error: Invalid foreign key for table 'roclinkparameterroctypeversion' Solution: Refer to Section 2.4, Address Systems Without ROC Tables, for more information. Error Related to Database Not Starting The system reports this error to the upgrade_schema_error.txt and the db.txt files: Error: Failed to start database, see below: Solution: Check the db.txt and fix the errors logged. Error Related to Missing Parameter This error can occur when running the UpgradeSchema.cmd; the first parameter of which must specify the previous version installed on the system. The system reports this error to the upgrade_schema_error.txt file: Error: Previous version was not specified as the first argument to the command file Solution: Check if the previous version is supplied as a command line parameter. Error Related to Unsupported Version This error can occur when the previous version is not supported for upgrade. The system reports this error to the upgrade_schema_error.txt file: Error: Upgrade not supported from version Service Pack Solution: Check the version number supplied as a command line parameter. You may need to upgrade the base version of OpenEnterprise from a pre-2.83 version to Error Related to Script Not Running as Administrator This error can occur if you run the UpgradeWorkstation.cmd, UpgradeServer.cmd, UpgradeOEMessaging.cmd, or UpgradeReporting.cmd files without administrator privileges. The system reports these errors to the log file: Error: Upgrade Workstation process failed: Run this tool as Administrator! Solution: To be able to make registry changes this script must be started with administrator privileges. When starting an upgrade script, right-click on the script and then select Run as Administrator. 30 Appendix A: Troubleshooting

35 Errors Related to Upgrade Folder Missing OpenEnterprise Version 3x Upgrade Guide These errors can occur when an upgrade script runs. The default path of the upgrade folder is C:\ProgramData\Emerson\OpenEnterprise\Upgrade, although this can be changed by providing another path as a command line parameter. The system reports this error to the upgrade_server_log.txt file: Error: Upgrade server process failed: Root folder specified '%ROOT_FOLDER%' does not exist or The system reports this error to the upgrade_workstation_log.txt file: Error: Upgrade workstation process failed: Root folder specified '%ROOT_FOLDER%' does not exist or The system reports this error to the upgrade_reporting_log.txt file: Error: Upgrade reporting process failed: Root folder specified '%ROOT_FOLDER%' does not exist or The system reports this error to the upgrade_oemessaging_log.txt file: Error: Upgrade OEMessaging process failed: Root folder specified '%ROOT_FOLDER%' does not exist Solution: Before running the script, verify that the upgrade folder exists and its current location is supplied. CreateUpgradeFolders.cmd Script Errors Error Related to Creating Folders This error can occur when the CreateUpgradeFolders.cmd runs. The system reports this error to the create_upgrade_folders_log.txt file: Error: Failed to create the folder structure Solution: Check disk space and whether the parent folder is read-only. You can create the folder structure manually (see Figure 2.1). Error Related to Registry Read CreateUpgradeFolder.cmd This error can occur when running the CreateUpgradeFolders.cmd and the OpenEnterprise Product Type couldn t be read from the registry. The system reports this error to the create_upgrade_folders_log.txt file: Error: Failed to read OpenEnterprise product type from the registry Solution: Make sure you run as the CreateUpgradeFolders.cmd with administrator privileges or create the folder structure manually. Appendix A: Troubleshooting 31