TeamConnect Enterprise 8.0 – Technical Playbook (Upgrade and Setup)

0 – Plan & align

0.1

Confirm client is targeting TeamConnect 8.0 and verify supported upgrade path from their current version (5.x–7.2).

All

Target version agreed; starting version confirmed to be within supported range.

Release notes PDF (link from): TeamConnect Enterprise Release Communication Page

0.2

Review lifecycle / support status and confirm that 8.0 meets client roadmap (modules, integrations, hosting).

All

Documented rationale for upgrading to 8.0; identified modules in scope.

TCE 8.0 Hub: TeamConnect Enterprise v8.0

0.3

Define snapshot, backup, and rollback strategy for all environments (including test runs).

DB, App, File store, DMS

Documented rollback triggers, decision makers, and backup/restore procedures validated in non‑prod.

Upgrade guide – backup recommendations

1 – Prerequisites & licensing

1.1

Confirm all required TeamConnect licenses, including modules (FM, CSM, ARIES, etc.).

TeamConnect

License inventory documented and aligned with modules in the 8.0 upgrade guide.

Upgrade guide: How to Ensure a Successful TeamConnect Enterprise 8.0 Upgrade?

1.2

Obtain TCE 8.0 installer / WAR/EAR / CLI and the Package Renamer Tool.

File repos

Install media and tools available in both non‑prod and prod file shares.

Upgrade guide (Prerequisites section)

1.3

Ensure non‑prod environments (DEV → TEST/UAT → STAGE) exist and can be refreshed from prod data.

DB, App, TeamConnect

Non‑prod refresh process documented and tested; backups verified.

Upgrade guide (Environment prerequisites)

1.4

Prepare CLI upgrade workspace (workstation or jump host) with Java, JDBC drivers, and configuration.

CLI, DB

CLI directory created with Java installed, JDBC JARs in lib, and upgrade.properties populated with DB credentials and license; test connection works.

Upgrade guide – CLI section

2 – Third‑party platform alignment & infra

2.1

Review Third‑Party Software Support matrix and confirm target DB, JDK, app server, browser stack for 8.0.

DB, App, JDK

Selected, supported versions recorded (Oracle 19c / SQL 2022; WebLogic / Liberty / Tomcat with JDK 21).

TeamConnect - Third Party Software Support

2.2

Confirm compute, block‑storage, and network sizing for TCE 8.0.

App, DB, Network

Sizing document updated; CPU/RAM/IO meet requirements; subnets/security lists allow outbound connections for search engines (e.g., ElasticSearch) and document services (e.g., HotDocs) where used.

Installation Requirements – sizing guidance

2.3

Validate TLS 1.2 (or higher) support across load balancers and app servers.

Network, App

TLS 1.2+ confirmed; any legacy endpoints remediated.

TLS 1.2 Upgrade Required for TeamConnect

2.4

Align and, if required, upgrade to a supported search engine stack (e.g., ElasticSearch).

Search, App, Network

Search nodes/cluster provisioned; indices built and validated in non‑prod; firewall rules documented and open for required ports.

Client‑specific search configuration; Third‑Party Support matrix

3 – Database server preparation

3.1

Provision DB server(s) on supported versions (Oracle 19c or SQL Server 2022).

DB

DB instances available, patched, and sized for TCE.

DB requirements: Database Requirements

3.2

Create TCE database/schema with required roles/privileges (Oracle: CONNECT, CTXAPP, CREATE TABLE/VIEW/PROC/SEQ/TRIGGER/MV; SQL: db_owner, snapshot isolation).

DB

Database created with required settings (snapshot isolation, autogrowth); connection tested.

Same as above

3.3

Perform a database sizing exercise (current size + growth projections) and document capacity plan.

DB

Initial & projected DB sizes approved; storage allocated.

Same as above

3.4

Validate schema readiness and backup/restore for Oracle 19c / SQL Server 2022.

DB

Recommended security/RU patch level applied; sufficient free tablespace with auto‑extend enabled; RMAN or equivalent backups and test restores verified in non‑prod.

Same as above

4 – Application server & JDK

4.1

Install target Oracle JDK 21 on app servers.

App, JDK

JDK 21 installed and set as default for TC services; for VM/containers, base images rebuilt; JVM options and memory sizing validated.

JDK guidance via Third‑Party Support + Upgrade guide

4.2

Install and configure supported application server: WebLogic 15.1.1, WebSphere Liberty 25.x, or Tomcat 10.1.x.

App

App server installed, patched, and reachable; same major version used consistently across DEV/TEST/UAT/PROD.

App servers: Application and Web Servers

4.3

Configure JDBC data sources to the TCE DB (drivers, connection pools) per app server guidance.

App, DB

Test connection from app server to TCE database succeeds.

Same as above

4.4

Apply 8.0‑specific app server configuration with JDK 21 (e.g., SOAP integration settings, Liberty/WebLogic deltas).

App

Configuration validated against documentation; sample applications or health checks run successfully.

TeamConnect 8.0 – Application Server Configuration with Oracle JDK 21TeamConnect 8.0 – Application Server Configuration with Oracle JDK 21

4.5

For Tomcat: apply relaxedQueryChars and other documented connector settings.

App

server.xml updated; Tomcat restarted without errors; test pages load successfully.

App servers article (Tomcat section)

5 – Custom code, libraries, and scans

5.1

Inventory all custom integrations, including JARs deployed into TeamConnect libraries or app server lib folders.

TeamConnect, App

Integration inventory completed and signed off.

Upgrade guide – “Impacts and Actions for Custom Integrations”

5.2

Use the API Scan utility to compare existing version vs 8.0 APIs, based on a design snapshot.

TeamConnect

API Scan output reviewed; impacted APIs identified.

Upgrade guide – API Scan reference

5.3

Run the Package Renamer Tool (javax → jakarta) on custom libraries where recommended.

TeamConnect, App

Updated JARs compiled and deployed to non‑prod; smoke tests pass.

Package Renamer Tool: Package Renamer Tool (TCE 8.0) - Admin Guide

5.4

Review Library Updates in TCE 8.0 (e.g., Apache POI/CXF, OpenPDF) and adjust code accordingly; audit custom JARs against the impacted‑library list.

TeamConnect

All affected custom integrations updated and unit‑tested; OpenPDF replaces iText where applicable; custom JARs reconciled with Mitratech’s “Impacted Library Files” list.

Library Updates in TeamConnect Enterprise 8.0

5.5

Specifically review and refactor any PDF‑generation custom code to OpenPDF syntax.

TeamConnect

All PDF customizations tested without iText; no runtime errors in core PDF flows (invoices, reports, document automation).

Upgrade guide – iText → OpenPDF section

6 – Install / upgrade TeamConnect (non‑prod first)

6.1

If using manual EXE upgrade path, bring environment to TCE 7.2 + latest module versions first, per guidance.

TeamConnect

Environment at 7.2 baseline with supported modules before moving to 8.0.

Upgrade guide – "What to keep in mind when going to 8.0"

6.2

Prefer CLI‑based upgrade for building proper upgrade paths for all modules.

TeamConnect

CLI upgrade scripts executed in non‑prod; logs archived; no critical errors.

Upgrade guide – CLI section

6.3

For new installs, run the TeamConnect 8.0 installer and generate WAR/EAR (or configure CLI install).

TeamConnect

WAR/EAR generated successfully; installer logs clean.

Installer Documents: Running the Installer

6.4

Prepare for deployment – copy WAR/EAR to the app server’s deployment location.

App, TeamConnect

Deployment package staged in the correct directory.

Preparing for Deployment 

6.5

Deploy TeamConnect to the app server and start the instance.

App, TeamConnect

Application starts without errors; login page reachable.

Deploying Documents: Deploying

6.6

Run initial smoke tests (login, basic navigation, record creation, search).

TeamConnect

Basic operations verified; major blockers logged and triaged.

Installation Guide TOC: TeamConnect Installation Guide Table of Contents

7 – Configure SAML SSO & authentication

7.1

For new SAML setups: configure IdP (Okta/Azure) app with ACS URL https://<tc-host>/login/saml2/sso/{RegistrationID} and email‑based NameID.

IdP

IdP app created; metadata URL and certificate available.

SAML Guide: SAML 2.0 SSO Installation and Configuration Guide for TeamConnect Enterprise v8.0+

7.2

In TeamConnect, create SAML registrations under System Settings → SAML Authentication Settings (one per IdP).

TeamConnect

SAML registrations created and saved; no validation errors.

Same as above

7.3

For upgrades from legacy SAML: remove legacy SAML server configuration and rebuild using integrated SAML SSO.

TeamConnect

Legacy SAML components disabled; IdP metadata and settings documented; new certificates generated and imported into System SAML configuration; IdP redirect URLs updated to /login/saml2/sso/{RegistrationID}.

Upgrade guide – SSO (SAML) integrated section

7.4

Configure mixed‑mode authentication (SAML for most users or selected users) per client’s preference.

TeamConnect

Default auth method set; user‑level overrides documented; admin/service accounts keep password access.

SAML guide – Mixed‑mode authentication

7.5

Validate all login flows: /login, /standardLogin, and SAML URLs.

TeamConnect, IdP

End‑to‑end SSO journeys pass; user mapping confirmed; error handling reviewed.

Same as above

8 – Logging & monitoring

8.1

Review app server logging destinations and configure TeamConnect appenders (file, SMTP, socket) as needed.

App, TeamConnect

Log files captured in agreed locations; rotation policy defined.

Appenders

8.2

Enable and test the Log Level Audit logger for system logging changes.

TeamConnect

Changes to logger levels appear in audit logs; access restricted to appropriate admin roles.

Same as above

8.3

Confirm ability to use Logging Level Timeout to temporarily increase logging without restart (demonstrate on a non‑prod instance).

TeamConnect

Timeout‑based debug logging verified; system returns to normal levels after timeout.

8.0 Release Notes (Logging improvements)

8.4

Configure and verify TeamConnect Performance Monitor (Glowroot) per guidance (on‑prem).

App, TeamConnect

Performance monitor UI accessible; sample traces captured; security/access controls validated.

TeamConnect Performance Monitor (TCE 8.0)

9 – Functional, integration, and performance validation

9.1

Run full functional regression for core objects (matters, invoices, contacts, tasks, reports).

TeamConnect

Regression pack executed; defects logged and triaged.

Client‑specific test plans + Upgrade guide recommendations

9.2

Validate all integrations (DMS, search, reporting, external systems) – paying attention to Spring URL changes and library updates.

TeamConnect, External

All integrations pass smoke + regression tests; URLs corrected for double slashes and login case sensitivity.

Upgrade guide – Strict URL updates / Library updates

9.3

Confirm SharePoint DMS connector updates and certificates (if applicable).

TeamConnect, DMS

New SharePointOnlineIntegration CLASS file and certificates deployed; app servers restarted; DMS operations (check‑in/out, search) verified.

Upgrade guide – DMS connector section

9.4

Plan deprecation of the legacy Office Suite add‑in and rollout of Outlook 365 add‑in.

Outlook, TeamConnect

Outlook 365 add‑in enabled (desktop & mobile); COM add‑in deprecation plan and user communication drafted.

Client‑specific Outlook add‑in docs

9.5

Execute performance and UAT validation using Performance Monitor and key integrations (HotDocs, ARIES widgets, Outlook add‑in, etc.).

TeamConnect, Performance Monitor, Integrations

Load/performance tests executed in staging; no critical bottlenecks; Glowroot/Performance Monitor dashboards reviewed for errors and slow transactions; UAT sign‑off obtained.

Performance Monitor guide; client test plans

10 – Cutover & post‑go‑live

10.1

Final prod backup of DB, app servers, file store, and DMS; create snapshots as needed.

DB, App

Restore point available in case of rollback; volume snapshots (or equivalent) configured for app and file stores; backup verification completed.

Upgrade guide – backup recommendations

10.2

Execute prod upgrade / installation following the validated non‑prod runbook.

All

Upgrade completed within window; health checks pass; key stakeholders informed.

All docs referenced above

10.3

Post‑go‑live health checks: login, SSO, critical integrations, Performance Monitor, logging & Log Level Audit.

All

Go‑live checklist signed off; monitoring dashboards green; no unresolved P1 issues.

SAML guide, Performance monitor, Appenders

10.4

Handover runbooks to client ops (SAML admin, logging level changes, common troubleshooting paths).

All

Runbook, credentials, and contact points documented and approved; ownership transitioned to BAU teams.

Internal project docs