Files
kontextual-engine/docs/cmis-1-1-capability-scorecard.md
2026-05-11 12:28:36 +02:00

163 lines
11 KiB
Markdown

# CMIS 1.1 Capability Scorecard
Date: 2026-05-07
Evidence update: the 2026-05-08 WP-0014 OpenCMIS pass moved the selected
baseline beyond the original folder-creatable skip boundary and through several
object/content maturity issues. The latest run, `run-20260508T164334Z`, reports
`repository-type` as warning-only and reduces `object-content` to specific
semantic gaps: invalid-type exception mapping, bulk update, content deletion,
change-token conflict handling, copy/create-from-source, and one range
classification warning. See
`docs/cmis-opencmis-tck-wp0014-evidence-2026-05-08T164334Z.md`.
The score below remains a product-depth estimate against mature CMIS products.
The selected OpenCMIS baseline still exits as `infrastructure_error`, but the
failure frontier is now narrow and capability-specific rather than basic
Browser Binding shape or navigation.
Status: baseline scorecard for the current Browser Binding subset.
## Purpose
Estimate how deep the current `kontextual-engine` CMIS 1.1 surface is when
compared with a mature, market-grade content services implementation.
This scorecard is not a certification claim and not a judgment of the engine's
native architecture. It measures only CMIS compatibility depth: how much a
generic CMIS client can expect to use without knowing Kontextual-specific
semantics.
## Benchmark
Primary CMIS-depth benchmark: **Hyland Alfresco Content Services**.
Rationale:
- Hyland/Alfresco documentation states that Alfresco Content Services fully
implements CMIS 1.0 and CMIS 1.1.
- The same documentation describes CMIS Browser, AtomPub, and Web Services
bindings as supported CMIS client entry points.
- Hyland is a recognized content services/document management vendor; Gartner's
2024 Document Management Magic Quadrant vendor list includes Hyland,
Laserfiche, M-Files, Microsoft, OpenText, and others.
Secondary market comparators for product context: OpenText, Hyland OnBase,
M-Files, and Laserfiche. These are useful commercial reference points, but
Hyland Alfresco is the cleanest CMIS-specific benchmark because its public docs
make a direct full-CMIS implementation claim.
Sources:
- OASIS CMIS 1.1 specification:
<https://docs.oasis-open.org/cmis/CMIS/v1.1/os/CMIS-v1.1-os.html>
- Hyland Alfresco Content Services 25.1 CMIS API docs:
<https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/25.1/Alfresco-Content-Services/Develop/Reference/CMIS-API>
- Gartner 2024 Document Management Magic Quadrant vendor list:
<https://www.gartner.com/en/documents/6030235>
## Scoring Rubric
| Score band | Meaning |
| --- | --- |
| 0-10% | Absent or intentionally unsupported. |
| 15-30% | Projection, metadata, or diagnostics exist, but CMIS clients cannot rely on the full service. |
| 35-55% | Useful constrained subset with explicit unsupported flags. |
| 60-75% | Production-usable subset for controlled clients, still missing notable optional or advanced behavior. |
| 80-95% | Mature implementation with broad client compatibility but not necessarily certified. |
| 100% | Benchmark-grade full CMIS 1.1 behavior for the capability area. |
Overall score uses weighted capability areas. The weights estimate practical
CMIS interoperability importance rather than engine-internal importance.
## Overall Estimate
| Metric | Score |
| --- | ---: |
| Weighted CMIS 1.1 depth vs Hyland Alfresco benchmark | 51% |
| Controlled-client Browser Binding usefulness | 70% |
| Broad commodity CMIS client compatibility | 46% |
Interpretation: the current CMIS layer is a credible Browser Binding subset for
known clients and profile-specific integrations. It is not yet a broad ECM/CMIS
replacement surface.
## Capability Scorecard
| CMIS capability area | Weight | Current depth | Most worthy contender | Gap basis behind the percentage |
| --- | ---: | ---: | --- | --- |
| Repository service and repository info | 5 | 82% | Hyland Alfresco ACS | - Repository info and conservative capability flags exist.<br>- Unsupported feature catalog exists.<br>- OpenCMIS `repository-type` is warning-only, with the remaining warning caused by local HTTP. |
| Type definitions | 6 | 52% | Hyland Alfresco ACS | - Base types and nullable content stream properties exist.<br>- No mutable types or custom schema/type management.<br>- Property definition depth remains intentionally narrow. |
| Navigation service | 8 | 58% | Hyland Alfresco ACS | - Root and folder-scoped children, path lookup, folder parent lookup, and parent path segments work.<br>- Projection-only parents exist.<br>- Missing `getDescendants`, `getFolderTree`, and real filing mutations. |
| Object read service | 10 | 78% | Hyland Alfresco ACS | - Object envelopes, properties, content descriptors, ACL projection, relationships, allowable actions, property filters, and path-addressed Browser Binding reads exist.<br>- Deleted/hidden objects are now correctly not exposed.<br>- Remaining read-side gaps are mostly around optional services and exception shape. |
| Object write service | 8 | 58% | Hyland Alfresco ACS | - `createDocument`, `createFolder`, scoped `moveObject`, folder rename, selected standard property updates, custom metadata updates, content stream set, and delete-request lifecycle exist.<br>- No bulk update, copy/create-from-source, broad filing mutation, or physical delete semantics.<br>- Delete is intentionally governed, not raw repository removal. |
| Content stream read/write | 8 | 74% | Hyland Alfresco ACS | - Byte streaming, explicit content headers, multipart Browser Binding create, deduplicating `setContentStream`, no-content compatibility streams, and partial body slicing exist.<br>- Digest verification and governed access exist.<br>- Remaining gaps are delete-content semantics, append semantics, change-token conflicts, and one range classification warning. |
| Versioning service | 8 | 25% | Hyland Alfresco ACS | - Version properties can be projected from engine versions.<br>- No checkout/checkin/cancelCheckout/PWC services.<br>- No version history route or all-versions query behavior. |
| Discovery/query | 8 | 25% | Hyland Alfresco ACS | - Narrow document select subset exists.<br>- Unsupported joins/order-by return diagnostics.<br>- Missing CMIS SQL predicates, type joins, full-text, ordering, and rich projection rules. |
| Relationships | 5 | 60% | Hyland Alfresco ACS | - Relationship object projection and source filtering exist.<br>- Visibility gates prevent protected relationship leakage.<br>- Missing full relationship service filters, relationship creation through CMIS, and type hierarchy maturity. |
| ACL service | 6 | 35% | Hyland Alfresco ACS | - Discover-only ACL projection exists.<br>- `applyACL` is blocked as not implemented.<br>- Missing inherited/direct ACL fidelity, propagation, ACL mutation, and repository principal model. |
| Policy service | 3 | 10% | Hyland Alfresco ACS | - Native policy decisions govern exposure.<br>- No CMIS policy objects, `applyPolicy`, `removePolicy`, or `getAppliedPolicies` service surface.<br>- Explicitly unsupported. |
| Change log | 5 | 55% | Hyland Alfresco ACS | - Audit-backed object-id change entries and paging exist.<br>- Missing CMIS update-conflict behavior for reused change tokens and richer change event typing.<br>- Change-token maturity is now directly visible in OpenCMIS object/content. |
| Multi-filing and unfiling | 4 | 25% | Hyland Alfresco ACS | - Projection-only parent maps exist and are useful for navigation.<br>- Standard CMIS `capabilityMultifiling` is correctly false.<br>- No add/remove filing mutations or canonical folder membership model. |
| Renditions | 3 | 15% | Hyland Alfresco ACS | - Native representations could become rendition candidates later.<br>- CMIS rendition capability is currently `none`.<br>- No rendition taxonomy or rendition stream routes. |
| Retention and hold | 2 | 5% | OpenText / Hyland governance stacks | - Native governance metadata can represent intent later.<br>- No CMIS retention/hold model or mutation services.<br>- Explicitly unsupported. |
| Bulk update | 2 | 5% | Hyland Alfresco ACS | - Native batch/error envelopes exist elsewhere in the engine.<br>- No CMIS `bulkUpdateProperties` behavior.<br>- Explicitly unsupported. |
| Browser Binding protocol fidelity | 7 | 66% | Hyland Alfresco ACS | - Browser-style routes, JSON envelopes, action aliases, multipart forms, path-addressed root routes, property filters, path segments, and range responses exist.<br>- Optional actions and CMIS exception mapping remain incomplete.<br>- Route-level CMIS tests run under the service extras and OpenCMIS now exercises object/content deeply. |
| AtomPub binding | 2 | 0% | Hyland Alfresco ACS | - No AtomPub/XML service document or feeds.<br>- Intentionally deferred until monetized need. |
| Web Services binding | 2 | 0% | Hyland Alfresco ACS | - No SOAP/WSDL stack.<br>- Intentionally deferred until monetized need. |
| External conformance evidence | 3 | 58% | OpenCMIS TCK against Alfresco-like server behavior | - OpenCMIS Browser Binding session creation succeeds against `compat-tck`.<br>- Selected `repository-type` baseline is warning-only.<br>- `object-content` executes concrete CRUD/content cases and is now blocked by a short list of semantic gaps rather than startup, path, paging, or basic content-read failures. |
Weighted result from this table: **51%**.
## Most Important Gaps
1. **External conformance expansion**
- Keep the selected OpenCMIS TCK baseline running against `compat-tck`.
- Close or explicitly waive the remaining object/content gaps: exception
mapping, bulk update, delete content, change-token conflicts, copy, and
offset-zero range classification.
- Expand selected groups after the supported object/content baseline is
stable.
2. **Browser Binding fidelity**
- Align route/action/selector shapes more closely with CMIS Browser Binding.
- Add non-skipped FastAPI route tests in CI with service extras installed.
- Add client smoke tests with Apache Chemistry/OpenCMIS where feasible.
- Return CMIS-specific exception classes/statuses instead of generic runtime
exceptions where OpenCMIS distinguishes invalid argument, constraint, and
update conflict.
3. **Query depth**
- Add a real CMIS SQL subset parser instead of a two-query allowlist.
- Support basic `WHERE`, equality predicates, paging, ordering where claimed,
and diagnostics for everything outside the subset.
4. **Navigation depth**
- Decide whether `getDescendants` and `getFolderTree` are worth implementing
over projection-only folders.
- Keep mutating filing unsupported unless a client explicitly needs it.
5. **Versioning depth**
- Keep PWC/checkin/checkout unsupported for now.
- Add version-history read support if document-management integrations begin
depending on it.
6. **Renditions**
- Map selected derived representations to CMIS renditions only after we have
stable representation taxonomy and real preview/thumbnail use cases.
## Product Positioning Takeaway
Against a mature CMIS implementation such as Hyland Alfresco ACS, Kontextual is
not trying to win by being a full ECM clone. Its current strength is a governed,
profiled, source-grounded knowledge runtime with enough CMIS Browser Binding
surface for controlled interoperability.
The right strategic posture is therefore:
- advertise a conservative CMIS 1.1 Browser Binding subset,
- keep unsupported capability flags honest,
- use the scorecard to decide which gaps are worth closing for real clients,
- avoid AtomPub/Web Services and full ECM semantics unless revenue or a named
integration justifies the complexity.