You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(features): catch up the features page with several releases of shipped work (#392)
* docs(features): catch up the features page with several releases of shipped work
The features.md page on docs.testplanit.com had fallen 80+ feature
and enhancement merges behind. Refreshes every section against the
current product surface and adds three new ones:
- Parameterized Test Cases (parameters, local + shared datasets,
iterations, sensitive values, exclude-draft-from-runs toggle)
- Review and Approval (gated workflow states, reviewer assignment,
strict transitive gates, reminders, system + per-project toggles)
- Result Governance (required fields, edit window, flip
justification, linked-issue-on-failure)
- Webhooks and Extensibility as a top-level section covering
outbound events, inbound issue-tracker sync, and the MCP server
for agent integrations
Existing sections gained entries for items shipped since the prior
revision: immutable completed runs, SSE-driven live updates, PDF
exports, GitLab + Gitea + GitHub Enterprise integrations, OAuth 2.0
for issue trackers, generate-from-URL, Mobilewright templates,
prompt configurations, additional locales, self-registration toggle,
expanded audit coverage, API tokens, multi-tenant + external-DB
deployment options, configurable JUnit iteration-property mapping,
folder + tag report dimensions, Execution Log + Automation
Candidates + Parameter Iteration Matrix reports, cross-project
reports, and more.
No behavior changes; documentation only.
* docs(features): add Markdown Parsing, Duplicate Detection, Automation Candidates LLM ranking
Caught three shipped LLM features that the prior commit missed:
markdown-parsing assist on the import surface, semantic duplicate
detection layered on the syntactic scan, and the LLM ranking that
drives the Automation Candidates report. Also names the generic
OpenAI-compatible custom-endpoint provider explicitly so the
provider list is no longer using "and more" for a shipped option.
Copy file name to clipboardExpand all lines: docs/docs/features.md
+97-12Lines changed: 97 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,18 +23,52 @@ TestPlanIt is a comprehensive test management platform designed to help teams pl
23
23
-**Custom fields** - Filter test cases by custom fields
24
24
-**Tags** - Apply tags to categorize and filter test cases across projects
25
25
-**Issues** - Attach issues to quickly navigate between test cases and related issues
26
+
-**External link attachments** - First-class link attachments alongside file uploads (paste a URL onto any drop zone)
26
27
-**Version history** - Track changes to test cases over time with full version control
27
28
-**Documentation pages** - Create wiki-style documentation pages within projects
29
+
-**Duplicate detection** - Background scan surfaces near-duplicate test cases at create time and from a dedicated review surface
30
+
-**Copy / move** - Reorganize cases across folders and projects, including in-place reordering
31
+
32
+
### Parameterized Test Cases
33
+
34
+
-**Named typed parameters** - Declare STRING / INTEGER / BOOLEAN / SELECT parameters on a case and reference them in steps via `@chip` mentions
35
+
-**Local + shared datasets** - Each case can have its own owner-bound dataset, or assign a project-scoped shared dataset and map its columns to the case's parameter names
36
+
-**Version pinning** - Pin a case to a specific shared-dataset version, or follow the latest
37
+
-**Iterations** - Parameterized cases run once per dataset row in a test run, each with its own per-row status; the case-level status rolls up as worst-of
38
+
-**CSV import** - Paste-CSV and full upload wizard for bulk dataset row authoring
39
+
-**Sensitive values** - Mark a parameter sensitive to mask it in the UI and redact it in exports and notifications for users without read-sensitive permission
40
+
-**Parameter Iteration Matrix report** - Pre-built report that pivots iteration outcomes across runs
41
+
-**Exclude draft cases from runs** - Opt-in per-project setting that keeps Not Started cases out of the Add Cases picker and auto-removes them from open runs when reverted
42
+
43
+
### Review & Approval
44
+
45
+
-**Gated workflow states** - Mark any workflow state as "requires review"; transitions into it (or across it) need an approved review request
46
+
-**Reviewer assignment** - Request review from a specific user or any holder of a role; reviewers see their queue in a Review Inbox
47
+
-**Strict transitive gates** - A single transition crossing multiple gated states requires an approval for each one
48
+
-**Decision audit** - All decisions, comments, and reminders are recorded and emitted as outbound webhook events
49
+
-**Reminders** - Configurable hourly scheduler nudges reviewers when requests sit pending past a threshold
50
+
-**System + per-project toggles** - System admins flip the master switch; project admins opt their project in independently
28
51
29
52
## Test Execution
30
53
31
54
### Test Runs
32
55
33
56
-**Flexible run creation** - Create test runs from entire folders, filtered sets, or individual test cases
34
57
-**Magic Select** - Create test runs from similar test cases using AI
35
-
-**Configuration support** - Execute tests against different configurations (browsers, environments, etc.)
58
+
-**Multi-configuration runs** - Execute tests against different configurations (browsers, environments, OS, etc.) in parallel; configurations are scoped to projects
36
59
-**Bulk status updates** - Quickly update multiple test results at once
37
60
-**Execution history** - View the complete history of test executions for any run or individual test case
61
+
-**Immutable completed runs** - Once a run is marked complete its case set, results, and configuration are structurally frozen; admins can edit a single result via the audit-log-tracked override path
62
+
-**Live updates** - SSE-driven push so multiple testers watching the same run see each other's status changes without refreshing
63
+
-**PDF export** - Per-run PDF with expanded step details and per-iteration values; also available at the milestone level
64
+
-**Forecasting** - Live estimates of remaining duration based on historical pass/fail per case
65
+
66
+
### Result Governance
67
+
68
+
-**Required result fields** - Optional per-project requirement that result-recording forms must collect certain fields
69
+
-**Edit window** - Lock results from in-place edit after a configurable window; later edits go through the audited override path
70
+
-**Flip justification** - Require a justification note when a result flips a previously-passed iteration to failed (or vice versa)
71
+
-**Linked-issue requirement** - Optional per-project requirement that failures must be linked to an issue before save
38
72
39
73
### Automation Integration
40
74
@@ -43,6 +77,7 @@ TestPlanIt is a comprehensive test management platform designed to help teams pl
43
77
-**TestPlanIt CLI** - CLI tool for submitting test case results in popular formats
44
78
-**API access** - Push results programmatically via the REST API
45
79
-**WebdriverIO reporter** - Native integration with WebdriverIO test framework
80
+
-**JUnit iteration property mapping** - Configurable per-project list of JUnit property/attribute names the importer uses to detect the iteration index — defaults to `iteration`, fully customizable for any CI vocabulary
46
81
47
82
## Exploratory Testing
48
83
@@ -66,8 +101,13 @@ TestPlanIt is a comprehensive test management platform designed to help teams pl
66
101
### Issue Tracking Integration
67
102
68
103
-**Jira integration** - Link test cases and results to Jira issues
69
-
-**GitHub integration** - Connect with GitHub Issues for defect tracking
104
+
-**GitHub integration** - Connect with GitHub Issues for defect tracking; supports GitHub Enterprise Server via configurable API base URL
105
+
-**GitLab integration** - Link to GitLab.com or self-hosted GitLab issues
-**Azure DevOps integration** - Sync with Azure Boards work items
108
+
-**OAuth 2.0 authentication** - Use OAuth for GitHub, GitLab, and Gitea/Forgejo connections (no personal access token required)
109
+
-**Two-way sync** - Optional outbound notifications and inbound webhook updates between TestPlanIt and the issue tracker
110
+
-**Linked-issue context for AI** - Auto-tag and test case generation pull labels, components, and metadata from linked issues
71
111
-**Bi-directional linking** - Navigate seamlessly between tests and issues
72
112
73
113
## Reporting & Analytics
@@ -80,8 +120,12 @@ TestPlanIt is a comprehensive test management platform designed to help teams pl
80
120
81
121
### Reports
82
122
83
-
-**Report builder** - Create custom reports with drag-and-drop interface
123
+
-**Report builder** - Create custom reports with drag-and-drop interface, including folder and tag dimensions
84
124
-**Test run reports** - Detailed breakdowns of test execution results
125
+
-**Execution Log report** - Pre-built timeline of every result event with expanded step details
126
+
-**Automation Candidates report** - LLM-ranked list of manual cases best suited for automation, drawing on custom field signals and attached-issue metadata
127
+
-**Parameter Iteration Matrix** - Pivots per-iteration outcomes across runs for parameterized cases
128
+
-**Cross-project reports** - Aggregate results across multiple projects in a single view
85
129
-**Coverage analysis** - Understand what has been tested and what remains
86
130
-**Trend analysis** - Track quality metrics over time
87
131
-**Export options** - Export reports in CSV for stakeholders
@@ -95,57 +139,94 @@ TestPlanIt is a comprehensive test management platform designed to help teams pl
95
139
96
140
### LLM Integration
97
141
98
-
-**Test case generation** - Generate test cases from requirements using AI
99
-
-**QuickScript AI generation** - Convert manual test cases into automation scripts with AI, optionally informed by your code repository (GitHub, GitLab, Bitbucket, Azure DevOps, Gitea/Forgejo/Gogs)
142
+
-**Test case generation** - Generate test cases from requirements using AI; optional `includeParameters` toggle (admin-gated) for parameterized output
143
+
-**Generate from URL** - Crawl a webpage or sitemap and generate test cases targeting it
144
+
-**Markdown Parsing** - Pasted Markdown is parsed by an LLM into structured cases (name, steps, expected results, custom field values) on the Import Markdown surface
145
+
-**QuickScript AI generation** - Convert manual test cases into automation scripts with AI, optionally informed by your code repository (GitHub, GitLab, Bitbucket, Azure DevOps, Gitea/Forgejo/Gogs); ships with templates spanning web, mobile, API, and Mobilewright targets
100
146
-**Enhance Writing** - Get AI recommendations to improve writing for any rich text field
101
147
-**Magic Select** - AI-assisted test case selection for quickly building test runs
102
-
-**Auto Tag** - Automatically suggest and apply tags to test cases, test runs, and sessions using AI analysis
103
-
-**Multiple providers** - Support for OpenAI, Azure OpenAI, Anthropic, Ollama, and more
148
+
-**Auto Tag** - Automatically suggest and apply tags to test cases, test runs, and sessions using AI analysis; incorporates linked-issue context (Jira labels + components, etc.) for sharper suggestions
149
+
-**Duplicate Detection** - LLM-scored semantic similarity layered on top of the syntactic scan so near-duplicates with reworded steps are surfaced too
150
+
-**Automation Candidates ranking** - The Automation Candidates report (under [Reports](#reports)) is LLM-ranked over manual cases + their custom fields + drilled-down issue metadata
151
+
-**Prompt Configurations** - Per-feature prompt templates that admins can override system-wide or per project
152
+
-**Multiple providers** - Support for OpenAI, Azure OpenAI, Anthropic, Google Gemini, Ollama, plus a generic OpenAI-compatible custom endpoint, with per-feature provider routing
104
153
-**Privacy options** - Use local models for sensitive data with Ollama integration
154
+
-**Capability probing + billing periods** - Admin UI surfaces each provider's available capabilities and tracks usage against custom billing periods
155
+
156
+
### MCP Server
157
+
158
+
-**Model Context Protocol** - First-class MCP server exposing TestPlanIt entities as resources and tools so agents (Claude Desktop, Cursor, etc.) can read and edit cases, sessions, runs, and results
159
+
-**Auth-aware** - Operates within the calling user's permissions; honors all access policies the rest of the product enforces
105
160
106
161
## Administration
107
162
108
163
### User Management
109
164
110
-
-**Role-based access** - Define custom roles with granular permissions
165
+
-**Role-based access** - Define custom roles with granular permissions, including a per-area "Can Approve" right for Review & Approval reviewers
111
166
-**Groups** - Organize users into groups for easier permission management
112
167
-**SSO support** - Integrate with your identity provider via SAML, Google OAuth, Apple Sign In, or Microsoft (Azure AD)
168
+
-**Magic Link sign-in** - Optional passwordless email link as an alternative to password authentication
169
+
-**Self-registration toggle** - Admin-controlled switch for letting users create their own accounts (or restricting account creation to admins)
113
170
114
171
### Customization
115
172
116
173
-**Custom workflows** - Define status workflows that match your process
117
174
-**Custom statuses** - Create statuses with custom icons and colors
118
175
-**Templates** - Create templates for consistent test case structure
119
-
-**User preferences** - Configure theme, locale, timezone, and date/time formats
176
+
-**User preferences** - Configure theme, locale, timezone, and date/time formats; preference selections are visible from the profile view as well as the editor
177
+
-**Configurations** - Author OS / browser / environment configurations scoped to projects, with an admin UX overhaul covering bulk assign and search
120
178
121
179
### Security & Compliance
122
180
123
181
-**Password policy** - Configure minimum length, character requirements, history depth, and expiration
124
182
-**Account lockout** - Protect against brute-force attacks with configurable threshold and duration
125
183
-**Password enforcement** - Force password changes (individual or bulk) and revoke passwords
126
184
-**Password strength indicator** - Real-time zxcvbn-powered feedback on signup and password change forms
127
-
-**Audit logs** - Track all changes for compliance and security review
185
+
-**Audit logs** - Track all changes for compliance and security review; covers admin configuration mutations, system-actor attribution, and a tamper-evident archive surface for long-term retention
128
186
-**Two-factor authentication** - Add an extra layer of security for user accounts
129
187
-**Data encryption** - Secure data at rest and in transit
188
+
-**API tokens** - Personal and service-account API tokens with scoped access and revocation
130
189
131
190
## Collaboration
132
191
133
192
### Team Features
134
193
135
194
-**Comments** - Discuss test cases and results with your team
136
-
-**Notifications** - Stay informed about changes and assignments
195
+
-**Notifications** - Stay informed about changes and assignments via in-app inbox, email, or daily digest
196
+
-**Real-time notification delivery** - Server-sent events push the bell badge instantly, no polling
137
197
-**@mentions** - Tag team members in discussions
138
198
-**Activity feeds** - See recent activity across your projects
199
+
-**Localized UI** - Ship-with-product localization for 13 locales including English, German, Spanish, French, Italian, Japanese, Korean, Dutch, Polish, Portuguese (Brazil), Russian, Turkish, Vietnamese, and Simplified + Traditional Chinese
139
200
140
201
### Import & Export
141
202
142
203
-**Drag and drop import** - Drag files directly from your desktop onto the Repository or Test Runs page to instantly start an import with the file pre-loaded
143
204
-**Bulk import** - Import test cases from CSV with automatic markdown/HTML detection for rich text fields
205
+
-**Markdown import** - Paste markdown source directly to seed cases, steps, and documentation pages
144
206
-**Test Results import** - Import automated test results via popular formats like JUnit XML
145
207
-**TestMo migration** - Special import support for migrating from Testmo
146
208
-**Export capabilities** - Export data in CSV or PDF, with markdown format option for rich text fields
209
+
-**Data Lake Export** - Project-scoped export endpoints that emit normalized JSON for warehouse pipelines
147
210
-**API access** - Full programmatic access to all features
148
211
212
+
## Webhooks & Extensibility
213
+
214
+
### Outbound Webhooks
215
+
216
+
-**Per-project endpoints** - Configure webhook destinations from project settings, with HMAC signing and optional Slack adapter
217
+
-**Event catalog** - Subscribe to fine-grained events: case lifecycle, run completion, per-iteration results, session updates, review requests, review decisions, reviewer reminders, and more
-**Replay + audit** - Failed deliveries are queued, retried with exponential backoff, and replayable from the admin surface; every delivery is audited
220
+
221
+
### Inbound Webhooks
222
+
223
+
-**Issue-tracker sync** - Configure inbound webhooks from Jira / GitHub / GitLab / Gitea so issue updates flow back into TestPlanIt
224
+
-**Adapter-aware** - The inbound config is keyed to the issue integration so swapping providers cleanly resets the webhook
225
+
226
+
### Agent Integrations
227
+
228
+
-**MCP Server** - See [AI-Powered Features → MCP Server](#mcp-server) — first-class Model Context Protocol surface so Claude Desktop, Cursor, and similar agents can read and edit TestPlanIt entities through the same access policies as the UI
229
+
149
230
## Search & Discovery
150
231
151
232
-**Advanced search** - Powerful search across all entities with complex filters
@@ -155,6 +236,10 @@ TestPlanIt is a comprehensive test management platform designed to help teams pl
155
236
156
237
## System & Operations
157
238
158
-
-**Background job processing** - Asynchronous task processing with BullMQ
0 commit comments