TeamConnect Enterprise JAVA API Explorer

Why This Exists

For years, the only way to navigate the TeamConnect Enterprise Java API was to download a static Javadoc zip, unpack it, and browse flat HTML files. No search beyond Ctrl+F. No code examples. No way to understand how classes relate to each other.

The TCE Java API Explorer replaces that workflow with an interactive, always-up-to-date web application.

Old vs New

Capability	Old Javadoc Zip	API Explorer
Search	Browser Ctrl+F only	Fuzzy search across classes, methods, params, return types — 5 search scopes
Code examples	None	Auto-generated snippets, multi-tab playground, full skeleton generator
Cross-referencing	Click links if they exist	Dependency graphs, type drill-down, breadcrumbs
Namespace migration	Manual find/replace (javax → jakarta)	Auto-converts via TC version toggle
Filtering	None	By kind, package, deprecated, @since, persona

Getting Started

Pick your persona — Partner, Services, or Admin (or "Show All") to tailor the home page and recipe filters
Set your TC toggle in the top bar:
- TC platform (7.x / 8.0) — auto-converts javax ↔ jakarta namespaces in all code
Search with Ctrl+K (or ⌘K on Mac), or browse the sidebar
Click a class → explore methods → expand cards → copy code

The Explorer has 4 main pages accessible from the top bar, plus the Class Detail view:

Page	What it shows
🏠 Home	Stats dashboard, persona ribbon, quick start guide, explorer features, popular services, package overview
📚 Recipes	Curated multi-step API workflow guides (e.g., "Create a Matter with Documents"). Filterable by persona. Auto-generated recipes for services without curated ones
🪄 Generate Code	Java skeleton generator — pick a context (CustomAction, ScheduledAction, CustomBlock, CustomCondition, CustomTool), choose an entity type, add services, and get a complete Java class with imports
📋 Cheat Sheet	Printable quick-reference: all Platform service getters, execution context table, common code patterns, javax→jakarta namespace map. Has a Print button
Class Detail	The main exploration view — class header, description, hierarchy, dependency graph, fields, constructors, methods (expandable cards), related recipes, quick start snippet

Key Features

Search & Discovery

Fuzzy search with 5 scope filters: All, Classes, Methods, Return Type, Param Type
Sidebar with collapsible package tree, kind filter chips (Service / Interface / Class / Enum / Exception), "Has Deprecated" and "Has @since" toggle filters
Recent searches (last 8) + Favorites (star any class for quick access)

Class Exploration

Class header: kind badge, fully-qualified name, Copy Import button (one-click import com.mitratech...), class annotations, @since version, deprecated method count
Method cards: click to expand — parameters with linked types, return type, annotations, throws, code examples
Method controls: filter by name, sort (A→Z / by return type / deprecated last), Expand All / Collapse All
Constructors, fields, enum constants — all with clickable type links
Floating Table of Contents for classes with many methods — collapsible, remembers your preference

Namespace Migration

TC platform toggle (7.x / 8.0) — auto-converts javax.servlet ↔ jakarta.servlet (and javax.mail ↔ jakarta.mail) in all code snippets, playground, and generated skeletons

Code Generation & Playground

Code Generator page — select a context type:
- CustomAction, ScheduledCustomAction, CustomBlock, CustomCondition, CustomTool
- Pick an entity type (Project, Contact, Invoice, etc.)
- Add services you need — generates a complete Java class skeleton with correct imports
Quick Start snippets — auto-generated per class with platform.get*Service() calls and imports
Multi-tab Playground — floating, draggable, resizable code editor:
- Syntax highlighting, line numbers, split-pane preview
- Rename, copy, download tabs
- Tab contents and window geometry persist across sessions (IndexedDB)
- Minimize to pill — collapses to an accent-colored floating pill (bottom-right) showing the active tab name and tab count; click to restore to previous position/size
Copy Import on every class header — one click to get the import statement

Recipes & Personas

Curated recipes — step-by-step guides chaining multiple API calls (e.g., "Search for Projects by Criteria", "Create an Invoice with Line Items")
Auto-imports — recipe code blocks automatically prepend detected import statements (TCE API types + Java stdlib) for copy-ready snippets
Send to Code Generator — sends the recipe's full code into the Code Generator skeleton, injected directly into the method body
Auto-generated recipes — services without curated recipes get an auto-generated quick start
3 personas tailored to different roles:

Persona	Best for	What it shows
Partner	Implementation partners building custom actions and rules	Essential classes like CustomAction, ProjectService, ContactService + tips on scaffolding
Services	PS/support engineers troubleshooting	UtilityService, SecurityService, SettingsService + cheat sheet tips
Admin	Admins configuring TeamConnect	ObjectDefinitionService, GroupService, UserService + deprecation warnings

Each persona shows essential classes and pro tips on the home page, and filters the Recipes page

Dependency & Hierarchy

Interactive SVG dependency graphs per class — see what it uses and what references it
Uses / Used By chip lists with one-click drill-down navigation
Inheritance chain visualization: superclass → current class → implements interfaces
Related classes section linking commonly co-used types

UI & Accessibility

7 themes: Light, Dark, Dracula, Monokai, One Dark Pro, One Dark Pro Flat, One Dark Pro Night Flat
Keyboard shortcuts (press ? to see all):

Shortcut	Action
`Ctrl+K` / `⌘K`	Open global search
`/`	Quick search (when not in an input)
`↑` / `↓`	Navigate search results
`Enter`	Select search result
`Esc`	Close search / overlay / panel
`?`	Show keyboard shortcuts panel

Deep linking — every class and method has a shareable permalink:
- #ClassName — links to a class
- #ClassName.methodName — links to a specific method
Responsive layout — works in iframe embeds and smaller screens (two-row top bar at narrow widths)
Open in new tab button — appears automatically when embedded in an iframe

Common Workflows

Find a Service Method

Filter the sidebar by "Service" kind chip
Click the service class
Use the method filter input to search by name
Expand a method card to see params, return type, and code examples

Check for Deprecated Methods

Enable the "Has Deprecated" filter in the sidebar
Browse classes that have deprecated methods
Sort methods by "Deprecated last" to see them grouped
Read deprecation notes for migration guidance

javax → jakarta Migration (TC 8.0)

TeamConnect 8.0 migrates servlet and mail APIs from javax to jakarta:

javax (7.x)	jakarta (8.0)
`javax.servlet`	`jakarta.servlet`
`javax.servlet.http`	`jakarta.servlet.http`
`javax.servlet.jsp`	`jakarta.servlet.jsp`
`javax.mail`	`jakarta.mail`

The Explorer handles this automatically. Toggle the TC platform version to 8.0 in the top bar, and every code snippet, playground tab, generated skeleton, and cheat sheet example will use jakarta namespaces.

The Cheat Sheet page has the full mapping table for quick reference.

Stats & Coverage

The Explorer indexes the complete TCE Enterprise Java API across both versions:

Metric	Value
Total classes	369+
Total methods	3,600+
Services	21
Packages	9 (model, service, enums, custom, search, parameters, callable, exception, api)
TC platform versions	7.x and 8.0 (namespace conversion)

Use the Changelog page for a detailed breakdown of what changed between 3.x and 4.x — added classes, removed classes, method count deltas, and deprecation counts.

What	Interactive explorer for the TCE Enterprise Java API — 369+ classes, 3,600+ methods
Replaces	Static Javadoc zip downloads
Works for	TC 7.x and 8.0 · Enterprise API (`com.mitratech.teamconnect.enterprise.api.*`)
Access	Web app — no install, no VPN required

TCE Java API Explorer — Interactive API Reference