# Upgrading the WEM Software

The information and instructions in this chapter should be used to upgrade a WEM installation. These instructions assume that you have already obtained the upgrade file(s) and have stored them on the server running the WEM application.

IMPORTANT:

The WEM application does not provide an automated mechanism for performing software “downgrades” (reverting to an older software version from a newer one). However, the instructions provided in the Performing a Manual Upgrade section of this chapter can be used since that procedure requires you to uninstall the existing version and install the alternate. Information is also provided for migrating database information.

Two upgrade types are currently supported:

Automated: Once executed, the WEM installation file detects previously installed versions of the application. If an older version is present, you are prompted as to whether or not you would like to perform an upgrade.

Because this process preserves all application database information from the currently installed version, it is only supported for n-2 releases, where n is the new version being installed. For example, the automated process can be used to upgrade either the 4.5.x or 5.0.x releases to version 5.1.x.

Manual: This type involves uninstalling any existing instances of the application and installing the new version.

This type must be used if the current instance is more than two releases older than the new version being installed. For example, the manual upgrade type must be used if 3.5.x is currently installed and you would like to upgrade to 5.1.x.

This chapter includes the following topics:

- Unpacking the Installation Files
- Performing an Automated Upgrade
- Performing a Manual Upgrade
- Reconfiguration of Bulkstat Schemas
- Preserving Database Information

IMPORTANT:

Unless otherwise specified, all information in this chapter applies to both Sun Solaris and Red Hat Enterprise Linux-based WEM systems.

Pre-Upgrade Procedures

IMPORTANT:

Make sure that you check the status of your system with your system administrator before proceeding to the section Performing an Automated Upgrade or Performing a Manual Upgrade.

XML Report Generation

You can enable/disable XML report generation of the bulk statistics by using “Generate XML Files”. Alternatively, it can be enabled/disabled by configuring the XMLDataEnable parameter to 1 in the bsserver.cfg file (in the /<ems_dir>/server/etc directory by default). If enabled, the files are stored on the EMS server (the /<ems_dir>/server/xmldata directory by default).

## Unpacking the Installation Files

WEM installation files are distributed as a single compressed file with a “.zip” extension.

Once the installation file has been copied to the server, unpack the zip file with 7-Zip or a similar utility. Decompressing the installation file results in the following files:

- setup.bin: The installation binary file.
- inst: The executable file used to initiate the installation. This file is used for both the console- and the GUI-based methods.
- uninst: Once the WEM application has been installed, this file must be copied to the /<ems_dir>/_uninst/ directory. It is the executable file for uninstalling the application for both the console- and GUI-based methods.
- <file_name>.zip: A compressed file containing all of the application files required for both the script- and GUI-based installation methods.
- README: A text file containing information pertaining to the release.
- sqlfiles.tar: Script Query Language files related to WEM database functionality.
- ems_migrate: A script that performs a backup or restore of the WEM databases.
- ems_migrate.cfg: A file that contains configuration information related to the ems_migrate script.
- README.ems_migrate: A text file containing information related to the EMS migrate functionality.

Performing an Automated Upgrade

This section provides information and instructions for performing an automated upgrade as described previously in this chapter.

Determining the Best Upgrade Method

The WEM, and its ancillary components such as the Apache web server and PostgreSQL database engine, may be installed using one of following methods.

- GUI-based method: This method is the most often used installation procedure. Requirements for using this method include: Logon account to the WEM server with display terminal (monitor) attached and some X-Windows client installed on server. Network connectivity to WEM server via Telnet or SSH, using some X-Windows client on remote workstation.
- Console-based method: This method is available to users who do not have an X-Windows client available for remote network connectivity to the WEM server via Telnet or SSH.

It is important to note that the upgrade method is independent of the method used for installation. For example, if the console-based method was used for installation, either the GUI- or console-based method can be used to perform the upgrade.

Depending on the desired installation method, proceed to either the Upgrading the WEM Software using the Console-Based Installation Method or Upgrading the WEM Software using the GUI-Based Installation Wizard section of this chapter.

### Upgrading the WEM Software using the GUI-Based Installation Wizard

Follow the instructions below to upgrade the WEM using the GUI-based wizard.

1. Go to the directory in which the WEM upgrade files are located.
2. Execute the setup file by entering the following command:

       ./inst

   The WEM Installer dialog box appears.
3. Click the Next button. The system automatically checks for an installed version of the application. If a version is installed, a warning dialog appears.
4. Click Yes to proceed.
5. Follow the on-screen prompts to progress through the various installation dialogs and configure the parameters as required. Refer to the WEM Installation Parameter Descriptions table for descriptions of the configurable parameters on each of the installation dialogs. Once you have completed the upgrade and all processes have started, a confirmation dialog box appears reporting that the installation was successful.
6. Click the Finish button to exit the GUI-based installation wizard.
7. Verify that all WEM processes were successfully started by looking at the on-screen messages in the console window. The following provides a sample of the messages:

       Starting EMS Server...

       EMS Server started.

       PID: 1370

       Logfile generated as:

       ./log/SERVER_LOG_20051220_142931/SERVER_LOG

       Please check file /<ems_dir>/server/log/.server.log
       for additional debug messages

       Starting Script Server...

       Script Server started.

       PID: 1389

       Logfile generated as:

       ./log/SCRIPT_LOG_20051220_142937/SCRIPT_LOG

   The following table lists the processes that are started at installation:

   Process | Log File
   --- | ---
   EMS Server | .server.log
   Script Server | .scriptserver.log
   BulkStat Server | .bulkstatserver.log
   BulkStat Parser Server | .bulkstatparser.log
   Monitor Server (if enabled) | .watchdog.log
   NorthBound Server | .northboundserver.log
   Notification Service | .notifyservicescript.log

   All log files are stored in the /<ems_dir>/server/log directory by default. Refer to the log files for additional information in the event that one or more of the processes did not start properly.
8. Copy the uninstallation script to the _uninst directory created during the installation process (/<ems_dir>/_uninst by default) by entering the following command:

       cp uninst /<ems_dir>/_uninst/

9. Copy the files pertaining to the migrate script to the scripts directory created during the installation process (/<ems_dir>/server/scripts by default) by entering the following command:

       cp ems_migrate /<ems_dir>/server/scripts

       cp README.ems_migrate /<ems_dir>/server/scripts

   IMPORTANT:

   You must reapply all bulkstat schemas that were in efferct prior to the upgrade, not just newly-supported schemas.

### Upgrading the WEM Software using the Console-Based Installation Method

Follow the instructions below to upgrade the WEM using the console-based installation script.

1. Go to the directory in which the WEM upgrade files are located.
2. Execute the setup file by entering the following command:

       ./inst -console

   A message appears welcoming you to the WEM installation.
3. Enter “1” to proceed to the EMS Upgrade Check configuration prompts. The system automatically checks for installed version of the application. If a version is installed, a message appears asking if you would like to upgrade the current installation.
4. Enter “1” to proceed.
5. Follow the on-screen prompts to proceed through the upgrade and configure the various parameters as required. Refer to the WEM Installation Parameter Descriptions table for descriptions of the configurable parameters within each of the sections of the script. Once you have completed the upgrade and all processes have started, you receive a message indicating that the WEM was successfully installed.
6. Enter “3” to complete the installation.
7. Verify that all WEM processes were successfully started by looking at the on-screen messages in the console window. The following provides a sample of the messages:

       Starting EMS Server...

       EMS Server started.

       PID: 1370

       Logfile generated as:

       ./log/SERVER_LOG_20051220_142931/SERVER_LOG

       Please check file /<ems_dir>/server/log/.server.log
       for additional debug messages

       Starting Script Server...

       Script Server started.

       PID: 1389

       Logfile generated as:

       ./log/SCRIPT_LOG_20051220_142937/SCRIPT_LOG

   The following table lists the processes that are started at installation:

   Process | Log File
   --- | ---
   EMS Server | .server.log
   Script Server | .scriptserver.log
   BulkStat Server | .bulkstatserver.log
   BulkStat Parser Server | .bulkstatparser.log
   Monitor Server (if enabled) | .watchdog.log
   NorthBound Server | .northboundserver.log
   Notification Service | .notifyservicescript.log

   All log files are stored in the /<ems_dir>/server/log directory by default. Refer to log files for additional information in the event that one or more of the processes did not start properly.
8. Copy the un-installation script to the _uninst directory created during the installation process (/<ems_dir>/_uninst by default) by entering the following command:

       cp uninst /<ems_dir>/_uninst/

9. Copy the files pertaining to the migrate script to the scripts directory created during the installation process (/<ems_dir>/server/scripts by default) by entering the following command:

       cp ems_migrate /<ems_dir>/server/scripts

       cp README.ems_migrate /<ems_dir>/server/scripts

   IMPORTANT:

   You must reapply all bulkstat schemas that were in effect prior to the upgrade, not just newly-supported schemas.

## Performing a Manual Upgrade

Follow the instructions in this section to perform a manual upgrade as described previously in this chapter. These instructions assume that a version of the application is currently installed and that it was installed in the default directory, /users/ems.

IMPORTANT:

The instructions in this section can also be used to perform a software downgrade of the WEM if required.

1. Log into the WEM server as the user root.
2. Optional. If you wish to preserve database information for the currently installed version, follow the instructions in the Performing a Database Back-Up using the backup Scriptsection of this chapter and then proceed to Step 3 of this procedure.
3. Uninstall the WEM using the instructions provided in the Uninstalling The WEM chapter of this guide and proceed to Step 4 of this procedure.
4. Install the desired version of the WEM using the instructions provided in the Installing the WEM Software chapter of this guide and proceed to Step 5 of this procedure.
5. Optional. If database information was backed-up per Step 2 of this procedure, restore the data using the instructions in the Performing a Database Restoration using the backup Script section of this chapter and proceed to Step 6 of this procedure.
6. Start WEM Server processes using the instructions in the Step 3: Start WEM Server Application section of WEM Server Files and Operation chapter of this guide.

   Note:

   After upgrading to a new version of WEM, it is recommended that the browser cache of the client workstation should be cleared, if it is enabled.

Reconfiguring Bulkstat Schemas

Once the WEM software upgrade is completed successfully, you are required to configure the schemas.

IMPORTANT:

Bulkstats must be reconfigured after an upgrade otherwise any new counters/schemas will not be fetched.

### Deleting an Already Configured Schema

For deleting the already configured schemas, follow the instructions below:

1. Login to the WEM application.
2. In the main menu, go to Accounting > Bulk Statistics Configuration. The Bulk Statistics dialog box opens.
3. Click the Configure button to launch the Bulk Statistics Configuration dialog box.
4. In the Schema tab, select all the configured schemas by clicking any row and then pressing Ctrl+A.
5. After selecting all the configured schemas, click the Delete icon. Warning message displays.
6. Click Yes to delete the selected schemas and click the Apply button. Another warning message displays.
7. Click No to ignore the warning. The successful configuration message displays.
8. Click OK to finish.

### Reconfiguring Schemas

For reconfiguration of schemas, follow the instructions below:

1. Login to the WEM application.
2. In the main menu, go to Accounting > Bulk Statistics Configuration. The Bulk Statistics dialog box opens.
3. Click the Configure button to launch the Bulk Statistics Configuration dialog box.
4. Select the schemas to be configured under the Schema tab and click the Add icon.
5. Click the Apply button to configure the selected schemas. You may get a warning message “You have selected some obsolete and/or WEM unsupported counters. Unsupported counters will not be parsed by WEM. Do you want to continue?”
6. Click Yes to close the warning. The successful configuration message displays.
7. Click OK to finish configuring schemas.

Preserving Database Information

Database preservation is done using the backup.sh script located in the /<ems_dir>/server/scripts directory by default. This script is used to perform both database back-ups and restorations.

Information and instructions for using this script are provided in this section.

### Performing a Database Back-Up using the Backup Script

Follow the instructions in this section to back-up database information prior to upgrading or downgrading WEM software.

IMPORTANT:

The instructions provided in this section are intended for use with those located in the Performing a Manual Upgrade section of this chapter.

1. Move to the directory in which the backup script is located by entering the following command:

       cd /<ems_dir>/server/scripts

2. Perform the database back-up by entering the following command:

       ./backup.sh

   This script automatically stops all WEM processes and takes the backup of the WEM database using pg_dumpall command. You are notified once the back-up is complete.
3. Return to Step 3 of the procedure in the Performing a Manual Upgrade section of this chapter.

### Restoring a Database Using the Backup Script

Follow the instructions in this section to restore database information after performing a WEM software upgrade or downgrade.

IMPORTANT:

The instructions provided in this section are intended for use with those located in the Performing a Manual Upgrade section of this chapter.

1. Move to the directory in which the backup script is located by entering the following command:

       cd /<ems_dir>/server/scripts

2. Perform the database restoration by entering the following command:

       ./backup.sh
       restore

   This script automatically stops all WEM processes and performs the database restoration. You are notified once the database restoration is complete.
3. Return to Step 6 of the procedure in the Performing a Manual Upgrade section of this chapter.