@cplace/test-mcp-server 0.1.15 → 1.1.0

package/dist/widget-specifications/_research_from_ga_products/cf-cplace-ecf-connector-extension-widget-cleanupConfigTable/research.md

@@ -0,0 +1,138 @@
+# Widget Research: cleanupConfigTable
+
+**Widget ID:** `cf.cplace.ecf.connector.extension.widget.cleanupConfigTable`
+**Repository:** `cplace-ecf`
+**Definition Class:** `cf.cplace.ecf/src/main/java/cf/cplace/ecf/cleanup/configuration/widget/CleanupConfigTableWidgetDefinition.java`
+
+---
+
+## 1. Purpose Summary
+
+The Cleanup Config Table widget displays a table of cleanup job configurations associated with a specific connector. It enables administrators to manage automated cleanup jobs that maintain data hygiene for synchronized entities within the Enterprise Connectivity Foundation (ECF) framework.
+
+---
+
+## 2. Core Functionality
+
+### What This Widget Does
+
+The widget renders a searchable table showing all `Cleanup Job Configuration` pages that belong to a specific Connector. It:
+
+- Displays cleanup job configurations filtered by the connector page it's embedded in
+- Allows users to view and manage scheduled cleanup jobs
+- Provides a structured interface for configuring data cleanup operations tied to synchronization configurations
+
+### Technical Implementation
+
+- **Inheritance:** Extends `AbstractConnectorTableWidgetDefinition` → `GenericSearchAsTableWidgetDefinition`
+- **Search Filter:** Filters cleanup configurations by `CONNECTOR` attribute matching the embedding page
+- **Embedding Restriction:** Can only be embedded on Connector pages or Connector TypeDefinitions
+
+The search handler (`CleanupConfigTableSpecificationHandler`) constructs a search that:
+1. Filters by the embedding space
+2. Filters by the `CleanupJobConfiguration` type
+3. Filters by the connector attribute matching the current connector page
+
+---
+
+## 3. Use Cases
+
+### Primary Use Cases
+
+1. **Manage Automated Cleanup Schedules**
+   - Administrators need to configure when cleanup jobs run for synchronized data
+   - The widget displays all cleanup configurations for a connector in one place
+   - Users can create, view, and modify cleanup schedules using cron expressions
+
+2. **Configure Orphaned Entity Deletion**
+   - When source entities are deleted, corresponding target entities become "orphaned"
+   - Users can enable automatic deletion of orphaned entities
+   - A configurable delay (in days) prevents premature deletion, allowing time for recovery
+
+3. **Associate Cleanup Jobs with Sync Configurations**
+   - Each cleanup configuration references one or more synchronization configurations
+   - This allows targeted cleanup for specific entity types or synchronization flows
+   - Validation ensures sync configurations aren't duplicated across cleanup jobs
+
+### When to Use This Widget
+
+- When setting up a new connector and needing to define cleanup policies
+- When managing existing cleanup schedules for synchronized data
+- When troubleshooting orphaned entities in a synchronization setup
+- When adjusting cleanup timing or enabling/disabling cleanup jobs
+
+---
+
+## 4. Configuration Concepts
+
+### Cleanup Job Configuration Attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| **Enabled** | Boolean | Controls whether cleanup jobs execute (default: false) |
+| **Connector** | Page Reference | Read-only link to the parent Connector page |
+| **Cron Expression** | String | Schedule for cleanup jobs (default: every 10 minutes - `* */10 * * * *`) |
+| **Synchronization Configurations** | Multi-Page Reference | References to sync configs this cleanup applies to (at least one required) |
+| **Delete Orphaned Target Entities** | Boolean | Enable automatic deletion of orphaned entities (default: false) |
+| **Delete After Days** | Number | Delay in days before orphaned entities are deleted |
+
+### Widget Layout on Cleanup Tab
+
+The widget is displayed in a split-view layout:
+- **Left column (6 cols):** The cleanup config table widget showing the list of configurations
+- **Right column (6 cols):** A connected attributes group showing details of the selected configuration, organized into:
+  - **General section:** Enabled, Cron Expression, Synchronization Configurations
+  - **Deleting Options section:** Delete Orphaned Target Entities, Delete After Days
+
+---
+
+## 5. Context and Related Components
+
+### Part of the Connector Page Layout
+
+The widget is one of three table widgets embedded in a Connector page's tabbed layout:
+
+| Tab | Widget | Purpose |
+|-----|--------|---------|
+| Servers | `ServerConnectionTableWidgetDefinition` | Server connection configurations |
+| Synchronization | `ConnectorSyncConfigsTableWidgetDefinition` | Synchronization configurations |
+| **Cleanup** | `CleanupConfigTableWidgetDefinition` | Cleanup job configurations |
+
+All three widgets inherit from `AbstractConnectorTableWidgetDefinition` which enforces embedding on Connector pages only.
+
+### Related Types and Services
+
+- **CleanupJobConfiguration Type:** `cf.cplace.ecf.cleanupJobConfiguration` - The custom type displayed by this widget
+- **CleanupJob:** Batch job that executes cleanup operations based on these configurations
+- **ExternalCleanupService:** Cleans up metadata for external entities
+- **DeleteOrphanedTargetEntitiesService:** Handles deletion of orphaned target entities
+
+### Validation
+
+- **Sync Configuration Uniqueness:** Each sync configuration can only be referenced in one cleanup configuration (validated by `CleanupConfigurationSyncConfigAttributeValidator`)
+- **Cron Expression Format:** Validated by `CronExpressionAttributeValidator`
+- **Delete After Days:** Must be a valid number if orphan deletion is enabled (validated by `DeleteOrphanedTargetEntitiesAttributeValidator`)
+
+---
+
+## 6. Localization
+
+| Key | English | German |
+|-----|---------|--------|
+| Widget Title | Sync Cleanup Job Configurations | Konfigurationen der Synchronisierungsbereinigungsjobs |
+| Tab Name | Cleanup | Bereinigung |
+
+---
+
+## 7. Files Analyzed
+
+| File | Purpose |
+|------|---------|
+| `CleanupConfigTableWidgetDefinition.java` | Widget definition class |
+| `CleanupConfigTableSpecificationHandler.java` | Search and table configuration |
+| `CleanupJobConfigurationWidgetDefinitions.java` | Individual configuration page layout |
+| `CleanupJobConfigurationTypeContainer.java` | Type and attribute definitions |
+| `AbstractConnectorTableWidgetDefinition.java` | Parent class with embedding restrictions |
+| `ConnectorTypeContainer.java` | Connector page layout with tabs |
+| `CleanupJob.java` | The batch job that uses these configurations |
+| `messages_en.properties` / `messages_de.properties` | Localization strings |

package/dist/widget-specifications/_research_from_ga_products/cf-cplace-ecf-connector-extension-widget-connectorSyncConfigsTable/research.md

@@ -0,0 +1,150 @@
+# Widget Research: connectorSyncConfigsTable
+
+## Widget Overview
+
+**Widget ID:** `cf.cplace.ecf.connector.extension.widget.connectorSyncConfigsTable`
+**Repository:** `cplace-ecf`
+**Definition Class:** `cf.cplace.ecf/src/main/java/cf/cplace/ecf/connector/extension/widget/ConnectorSyncConfigsTableWidgetDefinition.java`
+
+### Short Description
+
+Displays a table of synchronization configurations associated with a specific connector, enabling users to view and manage data sync rules between cplace and external systems.
+
+## Purpose
+
+The **Connector Sync Configs Table** widget is part of the Enterprise Connect Foundation (ECF) plugin. It provides a dedicated table view for managing synchronization configurations that belong to a specific connector page. The widget is designed to be embedded exclusively on Connector pages and displays all sync configurations that reference that connector.
+
+## Core Functionality
+
+### What It Does
+
+1. **Displays Sync Configurations**: Shows a table of ECF Sync Configuration entities that are linked to the current connector page
+2. **Search-Based Results**: Uses a search filter that finds all sync configurations where the `connector` attribute matches the current connector page
+3. **Workspace Scoped**: Results are filtered to the embedding space (workspace context)
+4. **Master-Detail Pattern Integration**: Works in conjunction with a Connected Attributes Group widget to enable selecting a row and viewing/editing its details in a side panel
+
+### Technical Implementation
+
+- **Extends**: `AbstractConnectorTableWidgetDefinition` → `GenericSearchAsTableWidgetDefinition`
+- **Specification Handler**: `ConnectorSyncConfigsTableSpecificationHandler` constructs the search query
+- **Search Logic**: Filters by type `ECF_SYNC_CONFIGURATION` and connector reference matching the embedding page
+- **Embedding Constraint**: Can only be embedded on Connector pages or their type definition
+
+## Use Cases
+
+### Primary Use Case: Managing Connector Synchronizations
+
+Users access this widget when they need to:
+
+1. **View all sync configurations** for a specific external system connector
+2. **Select and edit** individual sync configurations through the master-detail UI pattern
+3. **Monitor sync status** by seeing all configurations at a glance
+
+### User Workflow
+
+1. User navigates to a Connector page (representing a connection to an external system)
+2. User selects the "Synchronization" tab
+3. The widget displays all sync configurations in a table format
+4. User can select a row to view/edit details in the adjacent Connected Attributes Group widget
+
+### When Would a User Choose This Widget?
+
+This widget is **not directly chosen** by end users - it is a fixed component of the Connector page's "Synchronization" tab layout. It is automatically included in the default layout for Connector type pages as defined in `ConnectorTypeContainer`.
+
+**Configuration/Solution architects** would encounter this widget when:
+- Customizing the Connector type layout
+- Building ECF-based integration solutions
+- Setting up data synchronization between cplace and external systems
+
+## Configuration Concepts
+
+### Widget Configuration
+
+The widget has **minimal configuration options** as it is designed to work automatically within the Connector page context:
+
+- **No explicit search filter configuration**: The search is dynamically constructed based on the embedding context
+- **No column configuration**: Uses default columns (empty list returned, meaning platform defaults)
+- **Fixed embedding constraint**: Must be on a Connector page
+
+### Integration with Connector Tabs
+
+The Connector page type has three predefined tabs:
+1. **Servers Tab**: Server connection configurations table
+2. **Synchronization Tab**: This widget (sync configurations table)
+3. **Cleanup Tab**: Cleanup job configurations table
+
+Each tab follows the same master-detail pattern with a table widget on the left (6 columns) and a Connected Attributes Group widget on the right (6 columns) for editing selected rows.
+
+### Sync Configuration Attributes
+
+When viewing/editing a sync configuration through this widget's master-detail pattern, users can configure:
+
+| Attribute | Description |
+|-----------|-------------|
+| Enabled | Toggle to enable/disable the sync |
+| Server Connection | Which server connection to use |
+| External Type | The type in the external system to sync |
+| Sync Mode | Inbound, Outbound, or Bidirectional |
+| Creation Source | Where new entities are created (cplace, external, both) |
+| Workspace | Target workspace for sync operations |
+| Custom Type | Target cplace type for synchronized entities |
+| Search | Optional search filter to limit what entities are synced |
+| External Entity Link Attribute | Attribute used to link cplace pages to external entities |
+| Type Sync Parameters | Additional type-specific sync parameters |
+| Schedule | Cron expression for scheduled sync runs |
+
+## Related Components
+
+### Widget Family
+
+The widget is part of a family of connector-related table widgets that share the same base class:
+
+| Widget | Purpose |
+|--------|---------|
+| `ServerConnectionTableWidgetDefinition` | Displays server connection configurations |
+| `ConnectorSyncConfigsTableWidgetDefinition` | Displays sync configurations (this widget) |
+| `CleanupConfigTableWidgetDefinition` | Displays cleanup job configurations |
+
+### Dependencies
+
+- **ECF Plugin** (`cf.cplace.ecf`): The Enterprise Connect Foundation plugin
+- **GenericSearchAsTableWidgetDefinition**: Platform base class for search-as-table widgets
+- **ConnectedAttributesGroupWidgetDefinition**: Platform widget for master-detail editing
+- **LayoutTabsWidget**: Provides tabbed navigation on Connector pages
+
+### Type Dependencies
+
+- **Connector** (`cf.cplace.ecf.connector`): The page type this widget can be embedded on
+- **ECF Sync Configuration** (`cf.cplace.ecf.syncConfiguration`): The entity type displayed in the table
+
+## Localization
+
+| Language | Widget Name |
+|----------|-------------|
+| English | "Synchronization configurations" |
+| German | "Konfigurationen für die Synchronisierung" |
+
+## Implementation Notes
+
+### Key Files
+
+| File | Purpose |
+|------|---------|
+| `ConnectorSyncConfigsTableWidgetDefinition.java` | Widget definition and metadata |
+| `ConnectorSyncConfigsTableSpecificationHandler.java` | Search construction and column configuration |
+| `AbstractConnectorTableWidgetDefinition.java` | Base class with embedding validation |
+| `ConnectorTypeContainer.java` | Defines Connector type layout including this widget |
+| `EcfSyncConfigurationTypeContainer.java` | Defines the sync configuration entity type |
+
+### Extension Registration
+
+The widget is registered through `ConnectorPagePluginExtensionContainer`:
+
+```java
+private final GenericSearchAsTableWidgetDefinition syncConfigurationTable =
+    new ConnectorSyncConfigsTableWidgetDefinition();
+```
+
+## Summary
+
+The `connectorSyncConfigsTable` widget is a specialized table widget for the ECF plugin that displays synchronization configurations on Connector pages. It is not a general-purpose widget for solution builders but rather a fixed component of the Connector management UI. It enables administrators and integration specialists to view and manage all data sync rules for a given external system connection, following a master-detail pattern for efficient configuration editing.

package/dist/widget-specifications/_research_from_ga_products/cf-cplace-ecf-connector-extension-widget-serverConnectionTable/research.md

@@ -0,0 +1,181 @@
+# Widget Research: Server Connection Table Widget
+
+**Widget ID:** `cf.cplace.ecf.connector.extension.widget.serverConnectionTable`
+**Repository:** `cplace-ecf`
+**Plugin:** `cf.cplace.ecf` (Enterprise Connectivity Foundation)
+
+---
+
+## 1. Purpose Summary
+
+The Server Connection Table Widget displays and manages external server connection configurations belonging to a Connector page. It enables administrators to configure connections to external systems (such as Jira, SAP, or other enterprise platforms) that cplace synchronizes data with through the Enterprise Connectivity Foundation (ECF).
+
+**One-sentence description:** A table widget that displays server connection configurations for a Connector, enabling administrators to manage credentials and settings for external system integrations.
+
+---
+
+## 2. Core Functionality
+
+### What It Does
+
+- Displays a list of server connection configurations in a table format
+- Each row represents a connection to an external server with its URL and authentication settings
+- Works in a **master-detail pattern** with a Connected Attributes Group widget for editing selected connections
+- Automatically filters to show only connections belonging to the current Connector page
+
+### Data Displayed
+
+The widget shows `Server Connection Configuration` entities with these attributes:
+
+| Attribute | Description |
+|-----------|-------------|
+| Enabled | Whether the connection is active |
+| URL | Base server URL (must use https://) |
+| Authentication Method | BASIC_AUTHENTICATION or BEARER_TOKEN |
+| Username | Username for authentication |
+| Password/Token | Secure credential storage |
+
+### Technical Implementation
+
+- **Definition Class:** `ServerConnectionTableWidgetDefinition.java:26-62`
+- **Search Handler:** `ServerConnectionTableSpecificationHandler.java:25` - constructs the search query
+- **Inheritance:** Extends `AbstractConnectorTableWidgetDefinition` → `GenericSearchAsTableWidgetDefinition`
+- **Configuration Type:** Uses `cf.cplace.platform.script.genericSearchAsTable` for table configuration
+
+---
+
+## 3. Use Cases
+
+### Primary Use Case: Managing External System Connections
+
+Administrators use this widget to:
+
+1. **Configure External System Connections** - Set up connections to systems like Jira, SAP, or custom APIs that cplace needs to synchronize with
+2. **Manage Multiple Server Instances** - A single connector can have connections to multiple servers (e.g., development, staging, production environments)
+3. **Set Up Authentication** - Configure credentials using basic authentication (username/password) or bearer tokens
+4. **Enable/Disable Connections** - Quickly toggle connections on/off without deleting the configuration
+
+### When to Use This Widget
+
+- When building a Connector page that needs to communicate with external servers
+- When administrators need to manage connection settings for enterprise integrations
+- When multiple server environments need to be configured for the same connector type
+
+---
+
+## 4. Configuration Options
+
+### Widget Configuration
+
+The widget inherits standard table configuration from `GenericSearchAsTableWidgetDefinition`:
+
+- **Columns** - Column visibility and ordering
+- **Filters** - Filter settings for the table
+- **Height** - Fixed height setting for the widget
+
+### Embedding Restriction
+
+**Critical:** This widget can **only** be embedded on Connector pages (`cf.cplace.ecf.connector`). Attempting to embed it elsewhere will throw a `NotEmbeddableException`.
+
+The restriction is enforced in `AbstractConnectorTableWidgetDefinition.java:19-33`:
+```java
+throw new NotEmbeddableException("The widget can only be embedded on Connector pages.");
+```
+
+---
+
+## 5. Context and Related Components
+
+### Part of the ECF Feature Set
+
+This widget is part of the **Enterprise Connectivity Foundation (ECF)** plugin, which provides:
+
+- **Connector Framework** - Base infrastructure for building integrations
+- **Server Connection Management** - This widget's domain
+- **Synchronization Engine** - Data synchronization between cplace and external systems
+- **Cleanup Management** - Managing synchronized data lifecycle
+
+### Default Layout Configuration
+
+The widget is pre-configured in the Connector page's **"Servers" tab** with a master-detail layout:
+
+```
++---------------------------+---------------------------+
+|   Server Connection       |   Connected Attributes    |
+|   Table Widget            |   Group Widget            |
+|   (Selection - 6 cols)    |   (Details - 6 cols)      |
++---------------------------+---------------------------+
+```
+
+This layout is defined in `ConnectorTypeContainer.java:100-137`.
+
+### Related Components
+
+| Component | Purpose |
+|-----------|---------|
+| `Connected Attributes Group Widget` | Displays editable details of the selected server connection |
+| `ServerConnectionConfigurationValidator` | Validates URL format and tests connections |
+| `ServerConnectionConfigurationRepository` | Data access layer for server connections |
+| `Layout Tabs Widget` | Provides tab navigation (Servers, Synchronization, Cleanup) |
+
+### Validation Rules
+
+Server connection configurations are validated by `ServerConnectionConfigurationValidator.java:36-138`:
+
+- URL must use `https://` protocol
+- Username is required when using BASIC_AUTHENTICATION
+- Connection can be live-tested against the target server
+
+### Access Control
+
+- `ServerConnectionConfigurationMayEditAccessVoter` - Controls edit permissions
+- `PreventCreateServerConnectionConfigurationPages` - Server connections cannot be created directly from the type definition; they must be created from within a Connector's "Servers" tab
+
+---
+
+## 6. Prerequisites and Dependencies
+
+| Dependency | Description |
+|------------|-------------|
+| `cf.cplace.ecf` plugin | Enterprise Connectivity Foundation must be installed |
+| `PasswordPlugin` | Required for secure password/token storage |
+| `cf.cplace.layoutTabsWidget` | Used for tab navigation on Connector pages |
+| Connector Page | Widget must be embedded on a `cf.cplace.ecf.connector` page type |
+
+---
+
+## 7. Key Source Files
+
+| File | Purpose |
+|------|---------|
+| `ServerConnectionTableWidgetDefinition.java` | Widget definition and metadata |
+| `ServerConnectionTableSpecificationHandler.java` | Search query construction |
+| `AbstractConnectorTableWidgetDefinition.java` | Base class with embedding restrictions |
+| `ServerConnectionConfigurationTypeContainer.java` | Type definition for server connections |
+| `ServerConnectionConfigurationValidator.java` | Validation logic |
+| `ConnectorTypeContainer.java` | Default layout configuration |
+
+---
+
+## 8. Localization
+
+English labels from `messages_en.properties`:
+
+```properties
+serverconnection.widget.ServerConnectionTableWidgetDefinition.name=Server connection configurations
+serverconnection.repository.ServerConnectionConfigurationTypeContainer$SERVER_CONNECTION_CONFIGURATION.url_shortHelp=Base server connection URL, without additional path information.
+```
+
+---
+
+## Summary for Documentation
+
+**Short Description (1-2 sentences):**
+> The Server Connection Table Widget displays and manages server connection configurations for a Connector, allowing administrators to configure credentials, URLs, and authentication methods for external system integrations.
+
+**Key Conceptual Points:**
+1. Part of the Enterprise Connectivity Foundation (ECF) for building integrations
+2. Restricted to Connector pages only
+3. Works in master-detail pattern with Connected Attributes Group widget
+4. Manages authentication settings (basic auth or bearer token) for external APIs
+5. Supports multiple server connections per connector (e.g., different environments)