URS-SYS-001: System Configuration¶
| Property | Value |
|---|---|
| ID | URS-SYS-001 |
| Version | 1.0 |
| Status | Draft |
| Bounded Context | System |
| Author | |
| Approved By | |
| Date |
BR Traceability¶
| URS Requirement | Business Requirement | arc42 Reference |
|---|---|---|
| URS-SYS-001.1 | BR-08 | arc42/01 s1.1 |
| URS-SYS-001.2 | BR-08, BR-07 | arc42/01 s1.1 |
| URS-SYS-001.3 | BR-08 | arc42/01 s1.1 |
| URS-SYS-001.4 | BR-08 | arc42/07 s7.5 |
Scope¶
The System context manages global configuration variables, database version tracking, and system health monitoring for the Essert.MF standard product.
Requirements¶
URS-SYS-001.1: System Variable Management¶
Description: The system shall allow managing key-value system variables (get, set, list).
Acceptance Criteria: - Set a system variable with name and value - Get a system variable by name - List all system variables - Variables are persisted in the Essert database
GxP Relevance: Indirect Risk Class: Low
URS-SYS-001.2: Database Version History¶
Description: The system shall track database version history for audit purposes.
Acceptance Criteria: - Record database version with version number, description, and timestamp - List version history in chronological order - Version records include creator information
GxP Relevance: Direct Risk Class: Low
URS-SYS-001.3: System Health Check¶
Description: The system shall provide a health check endpoint to verify system availability and connectivity.
Acceptance Criteria: - Health check verifies connectivity to all 8 databases - Returns overall health status (healthy/degraded/unhealthy) - Response includes per-database connectivity status - Response time < 200ms under normal conditions
GxP Relevance: Supporting Risk Class: Low
URS-SYS-001.4: Automated Build, Test, and Publish Pipeline¶
Description: The system shall provide an automated CI pipeline (GitHub Actions) that builds the solution, runs unit tests, and publishes self-contained deployment artifacts on version tags.
Acceptance Criteria:
- Every push and pull request triggers automated build and unit test execution (Domain + Application tests)
- Version tags (v*) trigger automated self-contained publish of Essert.MF.Host.exe as a GitHub Release artifact
- Integration tests (Infrastructure + REST API) can be triggered on PRs and manually, running against a MariaDB service container
- Build failures and test failures block the pipeline and are reported to the developer
- Published artifacts contain the executable, configuration templates, and deployment scripts (install/uninstall)
GxP Relevance: Supporting Risk Class: Low
References¶
- Architecture: arc42/05 s5.2.4 — REST Controllers (SystemController)
- Related URS: URS-DAT-001