Phase 1 — Prepare the Environment for Conversion

Phase 2 — Upgrade the WebTMA5 Source Database

Phase 3 — Create the WebTMA7 Destination Database

Phase 4 — Configure the Upgrade Utility

Phase 5 — Execute the Upgrade

Phase 6 — Post-Upgrade Validation & Cleanup

Optional Phase — Transfer Request Forms
 

Notes on the Conversion of your Data:

The upgrade tool migrates most key data from your WebTMA5 database to the new WebTMA7 database (data model).  There are some data sets in WebTMA 5 which were not compatible with the new WebTMA7 data model. There are also a few data sets which were not originally included in the scope of the migration tool because we did not believe they were heavily used by on-premises clients but based on feedback we are adding to the tool in the coming weeks.  Key data not migrated during conversion includes:

• ATG Integration– End point URL will have to be updated
• BIM Interface Configuration - Not migrated. 
• Dashboard Threshold Alerts – These must be manually rebuilt as alerts 
• Custodial Management for Service Providers – Not migrated (but normal custodial management does migrate) 
• Custom SQL for Dashboards – Most custom SQL controls will need to be updated based on new data model 
• Depreciation Schedules – Feature Does not exist in WebTMA7 
• eMediTrack Configuration – End point URL will need to be updated to point to Service Request API 
• Grounds Management - No plans to migrate 
• iSD – No (TMA will swap out license for Service Request or Integration Suite (with APIs) as the replacement.  Please contact your Account Manager to discuss options.) 
• RSMeans Interface - Not migrated.
• Service Request Form -  Cannot migrate because of differences in functionality– Clients must manually build these forms.
• StarRez – URL for WebTMA end point has to be updated in StarRez (https://yoursite.com/api/v1/StarRezInterface) 
• Universal Interface Configurations – Yes (URL end points will have to be updated if you are using Webservice version of UI) 
• User Defaults - Not migrated.
• Wash Interface Configuration - End point URL will need to be updated to point to Service Request API 

Phase 1 – Prepare the Environment for Conversion

Objective

Validate the server environment, SQL Server prerequisites, source database compatibility, and required credentials prior to commencing the WebTMA 5 to WebTMA 7 conversion process.

Inputs

SQL Server 2022 installation, WebTMA 5 production database, SQL Server instance names, DBO credentials for source and destination databases, WebTMA 5 database version information.

Outputs

Fully validated server environment and confirmed readiness for upgrade to WebTMA 5 v5.1.50.

IMPORTANT: You should review this entire document prior to commencing your upgrade from WebTMA 5 to WebTMA 7.

Requirements Before Upgrade to WebTMA 7

• SQL Server 2022 must be installed on the server where you will be executing the WebTMA7 upgrade utility. We recommend a minimum of 32 GB of RAM on that server since the linked documents migration is memory intensive.
• Software and Hardware requirements for  WebTMA 7 On-Premises Installation (https://knowledgebase.tmasystems.net/hc/en-us/articles/8515845173389-WebTMA-v7-x-On-Premise-System-Requirements) 
• Name of the SQL Server where the source WebTMA 5 database will be housed, the name of the WebTMA 5 database on that SQL Server, and DBO credentials.
• Name of the SQL Server where the destination WebTMA 7 database will be housed, the name of the WebTMA 7 database on that SQL Server, and DBO credentials.

The WebTMA 7 Upgrade Utility requires the source database (a restored backup of your WebTMA 5 production database) to be at version 5.1.50.  Important: This does not require you to upgrade your production database or WebTMA 5 installation to 5.1.50; it only requires you to upgrade the restored backup being used as your source database.

*A copy of WebTMA 5 eTools for version 5.1.50 is available within the WebTMA 7 Upgrade Utility package, but to download the full 5.1.50 installer use this link: WebTMA 5.1.50

Database Version

Check your WebTMA 5 production database version by running the following SQL query:

SELECT AppVersion FROM f_webtmaCurrentVersion

Important: if you are running a version of WebTMA 5 v5.1.42 or lower, please execute the following SQL query:

SELECT COUNT(1) [Transaction Count] FROM f_keyTransaction

If the Transaction Count is greater than 20,000, stop your WebTMA 5 to WebTMA 7 upgrade process email support@tmasystems.com with the email subject:

Key Transactions exceed 20,000 [Your Organization Name] 

Then fill out the email body with a request for a WebTMA 5 v5.1.50 on-premises upgrade consultation. 

Please replace [Your Organization Name] with the name of your organization.

If the Transaction Count is less than 20,000 or you are running a version of WebTMA 5 below v5.1.50, then please execute eTools in accordance with the standard procedure included in the following phase to update your WebTMA 5 source database.

Phase 2 – Upgrade the WebTMA 5 Source Database

Objective

Back up and restore a copy of your WebTMA 5 production database.  Upgrade the restored WebTMA 5 source database to version 5.1.50.

Inputs

SQL Server Instance, DBO credentials, Database Name.

Outputs

Upgraded WebTMA 5 source database at version 5.1.50.

1. Make a backup of your WebTMA 5 production database.
2. Restore the database to the server on which you will perform the data conversion. 

Warning: The WebTMA 7 Upgrade Utility will potentially  update records in the WebTMA 5 source database. 

DO NOT EXECUTE the WebTMA 7 Upgrade Utility on your WebTMA 5 production database.

The WebTMA 7 Upgrade Utility includes a copy of WebTMA 5 eTools to upgrade your WebTMA 5 source database.  The eTools program is stored in the directory named: 1-WebTMA5.1.50_eTools:

1. Execute WebTMAeTools.exe as administrator.

   

2. Enter the Server, Username, Password, and Database information for your WebTMA 5 Source database.

   

3. Upon completion, the WebTMA 5 eTools application will output the following text:

   

Congratulations!  You have upgraded your WebTMA 5 source database to version 5.1.50.

Phase 3 – Create your WebTMA 7 Destination Database

Objective

Generate a clean WebTMA 7 destination database for migration.

Inputs

SQL Server Instance, DBO credentials, Database Name.

Outputs

Blank Template WebTMA 7 destination database.

The WebTMA 7 Upgrade Utility includes a copy of WebTMA 7 eTools to generate your WebTMA 7 destination database.  The eTools program is stored in the directory named 2-Web.7.0.VersionNumber_eTools:

1. Execute WebTMASQLPackage.exe as administrator:

   

2. Enter Server Name, Username, Password, and WebTMA 7 destination database name:

   

Upon completion, the WebTMA 7 database creation program displays the following:

Congratulations!  You have created your WebTMA 7 destination database.

Phase 4 — Configure the Upgrade Utility

Objective

Configure the WebTMA 7 Upgrade Utility to commence full data conversion.

Inputs

Source/Destination SQL Server Instance, DBO credentials, Source/Destination Database Names.

Outputs

Fully configured WebTMA 7 Upgrade Utility.

1. Open and run WebTMA 7 Upgrade Utility.exe as administrator.
2. Click the Configure WebTMA 5 Connection button. 
3. Enter the Server, Database, Username, and Password information. 

4. Test your connection string, save, and close the configuration dialog:

   

THEN,

1. Click the Configure WebTMA 7 Connection button. 

   

2. Enter the Server, Database, Username, and Password information.
3. Test your connection string, save, and close the configuration dialog:
4. Click the Validate Conversion Readiness button.

The WebTMA 5 Validated and WebTMA 7 Validated check marks should indicate checked:

Congratulations!  You have configured the WebTMA 7 Upgrade Utility to execute your data conversion. 

Safe Pause Point. The upgrade process may safely pause at this stage before conversion execution begins.

Phase 5 — Execute the Upgrade

Objective

Migrate relevant WebTMA data from the WebTMA 5 source database into the WebTMA 7 destination database.

Inputs

Button clicks on Commence Precheck and Commence Upgrade within the Upgrade Execution grid.

Outputs

WebTMA 7 database populated with WebTMA data.

Important: Upgrade execution duration varies based on database size and linked document volume. Large linked document migrations may require several hours to complete.

1. Click the Commence Precheck button in the Upgrade Execution grid of the WebTMA 7 Upgrade Utility application:

Feature Context

You receive consistent UI updates on package execution status in the Conversion Package Execution Status grid in addition to the text box in the Conversion Log grid. 

Execution controls in the Upgrade Execution grid are disabled during package execution and automatically re-enabled upon completion.

Feature Context

The text box under the Conversion Log grid will display your kickoff time.  This information is also written to the ConversionLog.txt in the WebTMA 7 Upgrade Utility directory:

When the Data Precheck has been completed, click the Commence Upgrade button.  A dialog window displays that must be acknowledged before package execution commences:

Important: In the event of a package execution failure, the WebTMA 7 Upgrade Utility continues to execute all remaining packages. 

Troubleshooting instructions for data errors are available here: https://knowledgebase.tmasystems.net/hc/en-us/articles/22097988476173-Troubleshooting-WebTMA7-On-Premise-Upgrade-Utility-Errors. 

The error messages are displayed in the text box in the Conversion Log grid in addition to being written to the ConversionLog.txt file in the WebTMA 7 Upgrade Utility directory:

The Commence Upgrade button will execute the Lookups | Types package to the Post Check package of the conversion packages. 

Upon completion, you should see the Conversion Package Execution Status grid filled out as shown below:

Congratulations!  You have finished converting your data from WebTMA 5 to WebTMA 7.  Please proceed to Phase 6 to perform all required data integrity checks for your database.

Phase 6 — Post-Upgrade Validation & Cleanup

Objective

Perform post-upgrade data validation and detect any orphaned records in your migrated WebTMA 7 destination database.

Inputs

Button click on the Commence Cleanup button in the Upgrade Execution grid.

Outputs

A fully populated WebTMA 7 database with validated data.

1. Click the Commence Cleanup button when the upgrade has been completed and all previous packages have executed successfully.

Feature Context

Upon successful completion of the Data Cleanup, the text box under the Conversion Log grid will display your completion time.  This information is also recorded in the ConversionLog.txt file in the WebTMA 7 Upgrade Utility directory:

Feature Context

Upon successful completion of the Data Cleanup, the text box under the Conversion Log grid will display the Record Count Validation output.  This information is also recorded in the ConversionLog.txt file in the WebTMA 7 Upgrade Utility directory:

Congratulations!  You have completed your Post-Upgrade Validation and Cleanup.

Please proceed with configuring your new WebTMA 7 database for use with your WebTMA 7 application in accordance with the WebTMA 7 configuration documentation here: https://knowledgebase.tmasystems.net/hc/en-us/articles/24093775847693-WebTMA7-On-Premise-Installati….  

If you need to transfer Service Request Forms or Request Portal Forms from your WebTMA 7 Test environment to your new WebTMA 7 environment, please continue to the next phase.

Optional Phase — Transfer Request Forms

Objective

Transfer Service Request Forms and Request Portal Forms from a previous WebTMA 7 test environment to your newly converted WebTMA 7 destination database.

Inputs

WebTMA 7 test environment SQL Server Instance, DBO credentials, and WebTMA 7 test environment database name.

Outputs

A fully populated WebTMA 7 database including Service Request Forms and Request Portal Forms from your previous WebTMA 7 test environment.

1. Click the Configure WebTMA 7 Test Connection Under the Service Request Transfer Execution grid. 
2. Enter the Server, Database, Username, and Password.
3.  Test the connection string, save the connection string.

4. Close the configuration dialog.

   

5. Click the Commence Service Request Transfer button under the Service Request Transfer Execution grid.

Congratulations! You have transferred your Service Request Portal Forms and Service Request Forms.  

Your conversion is complete!  Please proceed with configuring your new WebTMA 7 database for use with your WebTMA 7 application in accordance with the WebTMA 7 configuration documentation here: https://knowledgebase.tmasystems.net/hc/en-us/articles/24093775847693-WebTMA7-On-Premise-Installation-and-WebTMA7-Upgrade-Guide.