EcoSys Upgrade Guide Release 8.0.

02

Instructions for Upgrading EcoSys on Supported Platforms

Document Purpose

This document describes steps for performing an upgrade of EcoSys software. The contents below are
appropriate for:

Existing Installations
Troubleshooting existing configurations

The intended audience for this guide is: systems administrators, database administrators, application
administrators, and advanced application users responsible for technical configuration.

Contents
Upgrade Overview....................................................................................................................................................... 2

Upgrade Prerequisites and Checklist ........................................................................................................................... 2

Determining the Database Upgrade Path .................................................................................................................... 3

Upgrading the Database .............................................................................................................................................. 6

Updating the EcoSys Application on Tomcat ................................................................................................................ 7

Updating the EcoSys Application on JBoss EAP or WildFly ........................................................................................... 7

Updating the EcoSys Application on WebLogic ............................................................................................................ 8

Updating the EcoSys Application on WebSphere ......................................................................................................... 9

Updating the EcoSys SAP Adapter ............................................................................................................................... 9

Updating the Command Line Batch Job JAR Files ......................................................................................................... 9

Validating the EcoSys Upgrade .................................................................................................................................. 10

EcoSys Upgrade Guide, Release 8.0.02 Page 1 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
Upgrade Overview

Overview: This section describes the high level steps for upgrading EcoSys. You can use this as
a high-level checklist during the upgrade process.

Step References in This Document

Validate that you have met all the prerequisites for upgrading
Validate Prerequisites
EcoSys in the section Upgrade Prerequisites and Checklist.

Determine Database
Upgrade Path Determine which database scripts will need to be run, if any.

Upgrade Database Upgrade the EcoSys (ESFM) database instance for Oracle or
MS SQL Server.

Update EcoSys Web
Application
Optional: Update
EcoSys SAP Adapter
Update Command Line
Batch Library Files
Validate EcoSys
Upgrade
Update the EcoSys web application on your application server
platform: Tomcat, JBoss EAP / WildFly, WebLogic,
WebSphere.
Update the EcoSys SAP Adapter on your application server
platform: Tomcat, JBoss EAP/ WildFly, WebLogic,
WebSphere.
Update the library files used by EcoSys command line batch
jobs.
Validate the EcoSys upgrade and that all the features are
functioning.

Upgrade Prerequisites and Checklist

Overview: This section describes the prerequisites for upgrading EcoSys. You can use this as a
pre-upgrade checklist before initiating the upgrade process. These steps should be completed and
confirmed before the scheduled upgrade.

# Prerequisite Steps
Software Media on Server
1 The EcoSys installation/upgrade package (.zip file) should be downloaded and copied to
the application and database server(s) where the software will be upgraded.

EcoSys Upgrade Guide, Release 8.0.02 Page 2 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
 Passwords and Accounts
Before the upgrade, the following accounts and passwords will be required:
a. Application server administrator account and password, with either console or
2 remote access available.
b. Database accounts and passwords for the EcoSys database (typically ESFM) as
well as the database server administrator account.
Schedule Staff Availability
During the upgrade, the following people and roles will need to be available. It is
recommended that the upgrade consultant be provided with the contact information for
each of these roles at the client:
3 a. System Administrator, with admin-level access to application server(s)
b. Database Administrator, with DBA access to the database servers, and knowledge
of database policies and storage parameters.
c. Project Manager, with authority to make decisions about upgrade preferences and
the deployment priorities for EcoSys.
Stop Application and Integration Servers
Before initiating the upgrade process, shut down all EcoSys application and integration
4 servers that are running and connected to the EcoSys (ESFM) database instance being
upgraded.
Back Up Database
5 Before initiating the upgrade process, it is recommended to back up the EcoSys (ESFM)
database.

Determining the Database Upgrade Path

Overview: Using the current and target EcoSys (ESFM) database schema versions, as well as
the database platform, determine which database upgrade scripts will need to be run.

1. Determine the current database schema version.

Use one of the following methods:

a) Prior to shutting down the EcoSys application server(s), log in to the EcoSys web
application, navigate to System Information > Database, and make a note of the
'Current Database Version' value, or

b) Execute the following SQL query as the FMUSER database user:

Select database_version_name from systemsettings

EcoSys Upgrade Guide, Release 8.0.02 Page 3 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
2. Determine the target database schema version.

Use one of the following methods:

a) Open the EcoSys Release Notes for the target/upgrade version and make a note of the
required schema version value listed under Database Schema Version, or

b) Locate the target/upgrade version of EcoSys in the EcoSys Release column below and
make a note of its corresponding Database Schema Version value.

EcoSys Release Database Schema Version Database Upgrade Scripts To Run

7.0.01 0600.0005.0005 fm_or_upgrade_0600_0005_0004_0001_to_0600_0005_0005_0001.sql

7.0.02 0600.0005.0005 No database scripts required.

7.0.03 0600.0005.0005 No database scripts required.

7.0.04 0600.0006.0003 fm_or_upgrade_0600_0005_0005_0001_to_0600_0006_0001_0001.sql

fm_or_upgrade_0600_0006_0001_0001_to_0600_0006_0002_0001.sql
fm_or_upgrade_0600_0006_0002_0001_to_0600_0006_0003_0001.sql
fm_or_upgrade_0600_0006_0003_0001_to_0600_0006_0004_0001.sql
fm_or_upgrade_0600_0006_0004_0001_to_0600_0006_0005_0001.sql
7.1.01 0600.0006.0009 fm_or_upgrade_0600_0006_0005_0001_to_0600_0006_0006_0001.sql
fm_or_upgrade_0600_0006_0006_0001_to_0600_0006_0007_0001.sql
fm_or_upgrade_0600_0006_0007_0001_to_0600_0006_0008_0001.sql
fm_or_upgrade_0600_0006_0008_0001_to_0600_0006_0009_0001.sql
fm_or_upgrade_0600_0006_0009_0001_to_0600_0007_0001_0001.sql

fm_or_upgrade_0600_0007_0001_0001_to_0600_0007_0002_0001.sql
7.2.01 0600.0007.0003
fm_or_upgrade_0600_0007_0002_0001_to_0600_0007_0003_0001.sql

7.2.02 0600.0007.0004 fm_or_upgrade_0600_0007_0003_0001_to_0600_0007_0004_0001.sql

7.2.03 0600.0007.0004 No database scripts required.

fm_or_upgrade_0600_0007_0004_0001_to_0600_0007_0005_0001.sql
7.2.04 0600.0007.0006
fm_or_upgrade_0600_0007_0005_0001_to_0600_0007_0006_0001.sql

7.2.05 0600.0007.0007 fm_or_upgrade_0600_0007_0006_0001_to_0600_0007_0007_0001.sql

7.2.06 0600.0007.0007 No database scripts required.

7.3.01 0600.0007.0008 fm_or_upgrade_0600_0007_0007_0001_to_0600_0007_0008_0001.sql

fm_or_upgrade_0600_0007_0008_0001_to_0600_0007_0009_0001.sql
7.4.01 0600.0007.0011 fm_or_upgrade_0600_0007_0009_0001_to_0600_0007_0010_0001.sql
fm_or_upgrade_0600_0007_0010_0001_to_0600_0007_0011_0001.sql

7.4.02 0600.0007.0011 No database scripts required.

EcoSys Upgrade Guide, Release 8.0.02 Page 4 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
 fm_or_upgrade_0600_0007_0011_0001_to_0600_0007_0012_0001.sql
fm_or_upgrade_0600_0007_0012_0001_to_0600_0007_0013_0001.sql
7.4.03 0600.0007.0015
fm_or_upgrade_0600_0007_0013_0001_to_0600_0007_0014_0001.sql
fm_or_upgrade_0600_0007_0014_0001_to_0600_0007_0015_0001.sql

7.4.04 0600.0007.0015 No database scripts required.

7.4.04 0600.0007.0015 No database scripts required.

7.4.05 0600.0007.0015.0001 No database scripts required.

7.4.06 0600.0007.0015.0001 No database scripts required.

7.4.07 0600.0007.0015.0001 No database scripts required.

fm_or_upgrade_0600_0007_0015_0001_to_0600_0007_0016_0001.sql
7.4.08 0600.0007.0017.0001
fm_or_upgrade_0600_0007_0016_0001_to_0600_0007_0017_0001.sql

7.4.09 0600.0007.0017.0001 No database scripts required.

7.4.10 0600.0007.0017.0001 No database scripts required.

7.4.11 0600.0007.0017.0001 No database scripts required.

fm_or_upgrade_0600_0007_0017_0001_to_0600_0008_0001_0001.sql
fm_or_upgrade_0600_0008_0001_0001_to_0600_0008_0002_0001.sql
fm_or_upgrade_0600_0008_0002_0001_to_0600_0008_0003_0001.sql
fm_or_upgrade_0600_0008_0003_0001_to_0600_0008_0004_0001.sql
fm_or_upgrade_0600_0008_0004_0001_to_0600_0008_0005_0001.sql
7.5.01 0600.0008.0011.0001 fm_or_upgrade_0600_0008_0005_0001_to_0600_0008_0006_0001.sql
fm_or_upgrade_0600_0008_0006_0001_to_0600_0008_0007_0001.sql
fm_or_upgrade_0600_0008_0007_0001_to_0600_0008_0008_0001.sql
fm_or_upgrade_0600_0008_0008_0001_to_0600_0008_0009_0001.sql
fm_or_upgrade_0600_0008_0009_0001_to_0600_0008_0010_0001.sql
fm_or_upgrade_0600_0008_0010_0001_to_0600_0008_0011_0001.sql

7.5.02 0600.0008.0011.0001 No database scripts required.

7.5.03 0600.0008.0011.0001 No database scripts required.

fm_or_upgrade_0600_0008_0011_0001_to_0600_0008_0012_0001.sql
fm_or_upgrade_0600_0008_0012_0001_to_0600_0009_0001_0001.sql
7.6.01 0600.0009.0004.0001 fm_or_upgrade_0600_0009_0001_0001_to_0600_0009_0002_0001.sql
fm_or_upgrade_0600_0009_0002_0001_to_0600_0009_0003_0001.sql
fm_or_upgrade_0600_0009_0003_0001_to_0600_0009_0004_0001.sql

7.6.02 0600.0009.0004.0001 No database scripts required.

fm_or_upgrade_0600_0009_0004_0001_to_0600_0009_0005_0001.sql
fm_or_upgrade_0600_0009_0005_0001_to_0600_0010_0001_0001.sql
fm_or_upgrade_0600_0010_0001_0001_to_0600_0010_0002_0001.sql
fm_or_upgrade_0600_0010_0002_0001_to_0600_0010_0003_0001.sql
7.6.03 0600.0010.0007.0001
fm_or_upgrade_0600_0010_0003_0001_to_0600_0010_0004_0001.sql
fm_or_upgrade_0600_0010_0004_0001_to_0600_0010_0005_0001.sql
fm_or_upgrade_0600_0010_0005_0001_to_0600_0010_0006_0001.sql
fm_or_upgrade_0600_0010_0006_0001_to_0600_0010_0007_0001.sql

7.6.04 0600.0010.0007.0001 No database scripts required.

EcoSys Upgrade Guide, Release 8.0.02 Page 5 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
 7.7.01 0600.0011.0001.0001 fm_or_upgrade_0600_0010_0007_0001_to_0600_0011_0001_0001.sql

7.7.02 0600.0011.0001.0001 No database scripts required.

fm_or_upgrade_0600_0011_0001_0001_to_0600_0011_0002_0001.sql
fm_or_upgrade_0600_0011_0002_0001_to_0600_0011_0003_0001.sql
fm_or_upgrade_0600_0011_0003_0001_to_0600_0011_0004_0001.sql
8.0.01 0600_0012_0003_0001
fm_or_upgrade_0600_0011_0004_0001_to_0600_0012_0001_0001.sql
fm_or_upgrade_0600_0012_0001_0001_to_0600_0012_0002.0001.sql
fm_or_upgrade_0600_0012_0002_0001_to_0600_0012_0003_0001.sql

8.0.02 0600_0012_0003_0001 No database scripts required.

3. Determine which database upgrade scripts need to be run.

a) All database upgrade scripts listed between the current and target database schema
versions in the table above will need to be run.

IMPORTANT NOTES:

All scripts listed in the table above are for environments with Oracle databases. For
Microsoft SQL Server databases, replace fm_or with fm_ss in the script names.

Pay extra attention to the highlighted database upgrade scripts. Depending on the
database platform (Oracle vs. Microsoft SQL Server), they may need to be executed with
elevated database user privileges.

Upgrading the Database

Overview: Upgrading the EcoSys (ESFM) database instance for Oracle or Microsoft SQL Server.

1. Execute the database upgrade scripts.

a) Locate the database upgrade scripts directory in the EcoSys installation/upgrade

package for the database platform being used.

For Oracle databases, use /EcoSys/database/oracle/upgrades.

For Microsoft SQL Server databases, use /EcoSys/database/sqlserver/upgrades.

b) Open and view the contents of each script that will need to be run prior to doing so.
Some scripts require different permissions or may need a path in the script changed.

EcoSys Upgrade Guide, Release 8.0.02 Page 6 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
 c) Starting with the current database schema version and ending with the target database
schema version, execute all database scripts in order.

d) If an error or warning occurs, do not proceed with the next script. Contact EcoSys
Support.

e) Save the log files for each script execution as they may be needed for troubleshooting
purposes.

Updating the EcoSys Application on Tomcat

Overview: Updating the EcoSys web application on the Tomcat application server.

1. Stop the Tomcat service.

2. Delete the following folders:

<TOMCAT_HOME>\work\Catalina\localhost\ecosys
<TOMCAT_HOME>\webapps\ecosys

3. Replace the ecosys.war file in <TOMCAT_HOME>\webapps with the ecosys.war file in the
\deploy folder of the EcoSys installation/upgrade package.

4. Start the Tomcat service.

Updating the EcoSys Application on JBoss EAP or WildFly

Overview: Updating the EcoSys web application on the JBoss application server.

1. Stop the application server.

2. Delete the following folders:

<APP_SERVER_HOME>\standalone\tmp
<APP_SERVER__HOME>\standalone\data

3. Make a backup of the <APP_SERVER_HOME>\modules\com,

<APP_SERVER_HOME>\oracle, <APP_SERVER_HOME>\primavera directories.

4. Navigate to the C:\EcoSys\alt\deploy\ directory and extract and merge the new overlay zip
file to the root folder of the application server.

EcoSys Upgrade Guide, Release 8.0.02 Page 7 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
 For Oracle: Use the esfm-jboss-wildfly-overlay-ora.zip
For MSSQL: Use esfm-jboss-wildfly-overlay-sql.zip

5. Copy the correct database JDBC driver into the correct directory in the application server

For Oracle: copy the ojdbc6.jar file to com\ecosys\jdbc\main

For MSSQL: copy the sqljdbc4.jar file to com\ecosys\jdbc\main

6. If this is the first time upgrading to EcoSys 7.7 or greater, update the
<APP_SERVER_HOME>\standalone\configuration\standalone.xml file. Locate the line to
change below and update the entry as described. Remove any old driver entries that are
not used.

For Oracle:
Change: <driver name="ojdbc6" module="oracle.jdbc.6"/>
To: <driver name=" ojdbc6" module="com.ecosys.jdbc">
Remove: Any <driver></driver> sections for ojdbc5 and sqljdbc

For MSSQL:
Change: <driver name="sqljdbc" module="com.microsoft.sqlserver.jdbc">
To: <driver name="sqljdbc" module="com.ecosys.jdbc">
Remove: Any <driver></driver> sections for ojdbc5 and ojdbc6

7. If using Primavera P6, re-deploy the module by following the steps in the P6 Adapter
Installation guide.

8. Replace the ecosys.war file in <APP_SERVER_HOME>\standalone\deployments with the

ecosys.war file in the \deploy folder of the EcoSys installation/upgrade package.

9. Start the application server.

Updating the EcoSys Application on WebLogic

Overview: Updating the EcoSys web application on the WebLogic application server.

1. Stop the EcoSys managed server.

2. Delete the ecosys deployment.

3. Delete the following folders from the AdminServer and the Managed Server that is running
Ecosys App

<WLS_DOMAIN>\servers\<WLS_SERVER_NAME>\cache
<WLS_DOMAIN>\servers\<WLS_SERVER_NAME>\tmp
EcoSys Upgrade Guide, Release 8.0.02 Page 8 of 10
Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
 <WLS_DOMAIN>\servers\<WLS_SERVER_NAME>\stage (if it exists)

4. Deploy the ecosys.ear file from the \deploy folder of the EcoSys installation/upgrade
package to the EcoSys managed server.

NOTE: For more information on deploying the ecosys.ear file, refer to the Deploy the
EcoSys Application section under the heading Configuring Oracle WebLogic for EcoSys
in the EcoSys Installation Guide.

Updating the EcoSys Application on WebSphere

Overview: Updating the EcoSys application files on the WebSphere application server.

1. Stop the ecosys enterprise application.

2. Uninstall the ecosys enterprise application.

3. Delete the contents of the following folders:

<WEBSPHERE_HOME>\profiles\<Profile Name>\temp
<WEBSPHERE_HOME>\profiles\<Profile Name>\wstemp

4. Deploy the ecosys.ear file from the \deploy folder of the EcoSys installation/upgrade
package to the WebSphere application server.

NOTE: For more information on deploying the ecosys.ear file, refer to the "Deploying the
EcoSys Application on WebSphere" section under the heading "Configuring IBM
WebSphere for EcoSys" in the EcoSys Installation Guide.

Updating the EcoSys SAP Adapter

The EcoSys SAP Adapter web application is contained in the pluginsap.war file which can be found
in the \deploy folder of the EcoSys installation/upgrade package. To update an EcoSys SAP
Adapter deployment, follow the same instructions (based on the application server) used to update
the EcoSys web application but apply them to the pluginsap.war file instead of the ecosys.war/ear
file.

Updating the Command Line Batch Job JAR Files

EcoSys Upgrade Guide, Release 8.0.02 Page 9 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.
If the EcoSys environment being upgraded utilizes command line batch jobs, the JAR files in each
batch/lib folder being used will need to be updated. To do so, delete all JAR files (except for the
JDBC driver) in the /batch/lib folders and add all JAR files from the /batch/lib folder of the EcoSys
installation/upgrade package.

Validating the EcoSys Upgrade

After the EcoSys application service has been started, navigate to the EcoSys URL and attempt to
log in. Contact EcoSys Support if any errors are encountered after the upgrade and include the
upgrade script log files as well as the ESFM-Application.log file.

EcoSys Upgrade Guide, Release 8.0.02 Page 10 of 10

Copyright 2017 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
Confidential and Proprietary Information.