Upgrading EDM or Your Application

When a new version of EDM is available, you may want to install it on your central system, or on both your central and remote systems. It often happens that the changes in the new version only affect the central system so it is not necessary to upgrade all the remote installations. The central system version should always be equal to or later than any version running at a remote site.

When you install a new version of your application, EDM can support both the old and new versions of the application during the rollout period.

Upgrading Your Application

EDM can help support the process of upgrading your application when necessary. Many times during the rollout of a new version of your application there is a period when some of your sites have the old version and some have the new version. EDM can support multiple versions of your application at different sites at the same time.

To upgrade your application to a new version when you are currently using EDM to support the old version, take the following steps:

Step 1: Set up a lab system with the new version of the application

  1. In order to validate that your central system will be able to support sites running the old version of the application and sites running the new version of the application during the rollout, keep your existing lab site with the old version of the application and create a new lab site with the new version of the application. For example, if you currently have IRIS 3.7.4 in your sites and you are upgrading to IRIS 3.7.8, then keep your existing EDM lab system that is set up with IRIS 3.7.4 and install a new EDM remote lab system with a unique site number and the old version of the application. We will use the new lab site to validate the upgrade process.

  2. Configure the new lab system for web transfers with the central system (see Install.htm for instructions on configuring web transfers).

  3. If the version number for your application is not correct in the lab system's config.xml file (in the C:\EdmWeb folder by default), update the application data source version number. For example, if you installed the EDM remote with IRIS 3.7.8 but you used the setup_remote_IRIS_3.7.4PR10.bat batch file to do the installation, then change the version property in the dataSource element in the config.xml file from:

    <dataSource
    name = "IRIS"
    version = "3.7.4PR10"
    type = "SQLSERVER_JDBC"
    database = "IRIS"
    server = "localhost"
    user = "sa"
    password = ""/>

    TO:

    <dataSource
    name = "IRIS"
    version = "3.7.8"
    type = "SQLSERVER_JDBC"
    database = "IRIS"
    server = "localhost"
    user = "sa"
    password = ""/>

    Then, run go.bat so EDM will reload the application database structures with the correct version number.

Step 2: Load the data structures for the new version into the central system

  1. Backup the central system database (called EdmWebHQ by default).

  2. Backup the central system configuration files (in the C:\jakarta-tomcat-5.5.7\webapps\edm folder by default).

  3. On the central EDM system, send a Request Table List transaction to the lab site with the new version of the application.

  4. On the remote EDM lab system, double-click transfer_web.bat (in the C:\EdmWeb folder by default).

  5. On the central EDM system, click Transactions – Process All Transactions on the central site to process the received table list.

Step 3: Convert the central system database to support the new application data structures

  1. On the central EDM system, click the option on the Configuration menu Configure Application Versions to configure the new version.

  2. The first thing users have to tell the system is what order the versions are in so use the Move Up and Move Down buttons to adjust the order so the oldest version of each data source is at the top and the newest version is at the bottom.

  3. When the versions are in the proper order, click Confirm Version Sequence and the system will save the version sequence and automatically generate the conversions between each version.

  4. Use the Review Conversions button to review the table and column conversions to see if any tables or columns that were dropped and added were actually just renamed. Users can change drop/add conversions to rename conversions by selecting the conversion and clicking the Change to Rename button. Users can change a rename conversion to a drop/add conversion by selecting the conversion and clicking the Change to Delete button.

  5. Finally, users can tell the central database to convert the tables for a data source to the new version by selecting the new version and clicking the Convert Central Database button.

Step 4: Load new lab site data into central system

  1. On the central EDM system, send a Request Table Refresh transaction to the new lab site.

  2. On the remote EDM lab system, double-click transfer_web.bat (in the C:\EdmWeb folder by default).

  3. On the central EDM system, click Transactions – Process All Transactions on the central site to process the received data.

    At this point, the central system should be supporting both a lab system running the new version of your application and a lab system running the old version of your application. To continue updating all remaining sites to the newest version, proceed to steps 5 and 6 below.

Step 5: Update version number in remote system configuration file as sites are upgraded

  1. As your locations are upgraded to run the new version of the application, make sure the C:\EdmWeb\config.xml is updated to the correct data source version number (see step 2).

Step 6: Update version number in central system as sites are upgraded

  1. When the updated application is installed at each remote site, on the central EDM system, update the record in the CDMRemoteSource table (CDMRDSRC) to have the correct version number. For example, if IRIS 3.7.8 is installed at site 1234, update the record in CDMRemoteSources from:

    SITE NAME VERSION
    1234 IRIS 3.7.4PR10

    To:

    SITE NAME VERSION
    1234 IRIS 3.7.8

    or add a new record if no record for the IRIS data source at the site is found in the table.

  2. If the data in the site was changed as a result of upgrading the application and you want to load the changed data into the central database you can use Transactions – Request Table Refresh to ask the remote site to send the upgraded data. Remember, requesting table data only works if the requested data is NOT shared so be sure to unshare any shared site table before requesting a table refresh for them.

Upgrading from EDM 3.1 or Later

The following sections provide instructions for upgrading from EDM 3.1 or later to a newer version of EDM.

Upgrading a Central System

To upgrade a central system take the following steps:

  1. Determine the folder where EDM is installed (edmfolder) on the central web server. For example, your edmfolder may be C:/jakarta-tomcat-5.5.7/webapps/edm.

  2. Install the new edmclient.jar in the edmfolder.

  3. Install the new system.jar in edmfolder/WEB-INF/lib.

  4. Restart the Apache Tomcat service on the web server.

  5. Open the WEB-INF/log.txt file in the edmfolder to verify that the first line contains the new version number and the last line contains “Server ready!”. See example below.

Example successful startup WEB-INF/log.txt (time stamp and code locations removed):

INFO Started web version Version 3.7.1 at Thu Jan 12 11:45:43 MST 2006
INFO Loading configuration file: 'C:\jakarta-tomcat-5.5.7\webapps\edm\web-inf\classes\config.xml'
INFO Loading configuration for company 'HQ'
INFO Loading conversion file: C:\jakarta-tomcat-5.5.7\webapps\edm\web-inf\classes\convert_iris_3.7.4.xml
INFO Loading security configuration.
INFO Initializing company 'HQ'
INFO System database not created. Error code: 1801: [Microsoft][SQLServer 2000 Driver for JDBC][SQLServer]Database EdmWebHQ already exists.
INFO Checking database version
INFO Purging audit trail to 14 days
INFO Loading sites...
INFO Loading site groups...
INFO Loading remote tables...
INFO Checking transaction version...
INFO Server ready!

Upgrading a Remote System

To upgrade a remote system take the following steps:

  1. Determine the folder where EDM is installed (edmfolder) on the remote system. For example, your edmfolder may be C:/EdmWeb.

  2. Install the new system.jar in edmfolder/lib.

  3. Start EDM by running go.bat in the edmfolder and verify that the new version number is displayed on the splash screen.

Upgrading from EDM 3.0.x

The following sections provide instructions for upgrading from EDM 3.0.x or later to EDM 3.1 or later.

Upgrading a Central System

To upgrade a central system take the following steps:

  1. Determine the folder where EDM is installed (edmfolder) on the central web server. For example, your edmfolder may be C:/jakarta-tomcat-5.5.7/webapps/edm.

  2. Install the new edmclient.jar in the edmfolder.

  3. Install the new system.jar in edmfolder/WEB-INF/lib.

  4. Install the new app_application.xml in edmfolder/WEB-INF/classes.

  5. Install the new convert_application_version.xml in edmfolder/WEB-INF/classes.

  6. Restart the Apache Tomcat service on the web server.

  7. Open the WEB-INF/log.txt file in the edmfolder to verify that the first line contains the new version number and the last line contains “Server ready!”. See example below.

Upgrading a Remote System

To upgrade a remote system take the following steps:

  1. Determine the folder where EDM is installed (edmfolder) on the remote system. For example, your edmfolder may be C:/EdmWeb.

  2. Install the new system.jar in edmfolder/lib.

  3. Install the new app_application.xml in edmfolder.

  4. Install the new convert_application_version.xml in edmfolder.

  5. Start EDM by running go.bat in the edmfolder and verify that the new version number is displayed on the splash screen.

Upgrading from EDM 2.9.x or Earlier

The following sections provide instructions for upgrading from EDM 2.9.x or earlier (not web-based) to EDM 3.1 or later.

Upgrading a Central System

To upgrade a central system take the following steps:

  1. Follow the instructions for a Typical Lab Installation in to the installation instructions in Help/install.htm to get the central system installed and the central database initialized.

  2. Browse to the EDM main menu and select Locations – Delete Location Data to delete the remote location data loaded during installation.

  3. Use Locations – Edit Locations and Groups to delete the remote location record for the lab system.

  4. Run the import script obtained from your vendor to import the data from your EDM central database to your new EDM central database.

Upgrading a Remote System

To upgrade a remote system take the following steps:

  1. Make sure all transactions both to and from the remote location are transferred and processed before upgrading the remote system.

  2. Install EDM on the remote system according to the installation instructions.

  3. Uninstall the EDM software on the remote system by deleting the EDM folder and dropping the EDM database.

  4. On the central system, browse to the EDM main menu and use Application Objects – Tables – CDMLocations to edit the remote location's record and set the SENTTFN and RCVDTFN fields to 0.