Skip to content
EuroDMS Dev Guide

Reporting & Analytics

Reporting & Analytics

Section titled “Reporting & Analytics”

Quellverzeichnis: modules/reporting-analytics/

Betriebsberichte, Dashboards und Kennzahlen (ClickHouse).

Services

Section titled “Services”

Geschäftslogik des Moduls (src/services/):

  • BenchmarkNotFoundError
  • BenchmarkSampleTooSmallError
  • BenchmarkService
  • DashboardAccessDeniedError
  • DashboardAlreadyExistsError
  • DashboardNotFoundError
  • DashboardService
  • DashboardTerminalError
  • KpiAlreadyExistsError
  • KpiNotFoundError
  • KpiService
  • QueryExecutionError
  • QueryService
  • ReportService
  • SavedQueryAlreadyExistsError
  • SavedQueryNotFoundError
  • ScheduledReportAlreadyExistsError
  • ScheduledReportNotFoundError
  • ScheduledReportTerminalError
  • ThresholdNotFoundError
  • WidgetNotFoundError

Repositories

Section titled “Repositories”

Datenzugriffs-Ports (src/repositories/):

  • BenchmarkRepository
  • DashboardRepository
  • InMemoryBenchmarkRepository
  • InMemoryDashboardRepository
  • InMemoryKpiDefinitionRepository
  • InMemorySavedQueryRepository
  • InMemoryScheduledReportRepository
  • KpiDefinitionRepository
  • SavedQueryRepository
  • ScheduledReportRepository

Domain Events

Section titled “Domain Events”

Vom Modul emittierte Ereignisse (src/events.ts):

  • ANALYTICS_EVENT_TYPES
  • EventHandler
  • benchmarkUpdated
  • dashboardViewed
  • kpiThresholdExceeded
  • kpiThresholdRecovered
  • reportGenerated
  • reportScheduledTriggered

API-Endpunkte

Section titled “API-Endpunkte”

HTTP-Endpunkte unter api/routes/analytics/ — Details in der API-Referenz.

Methode Pfad Datei
GET /v1/analytics/benchmark benchmark.ts
POST /v1/analytics/benchmark benchmark.ts
GET /v1/analytics/benchmark/:id benchmark.ts
DELETE /v1/analytics/benchmark/:id benchmark.ts
POST /v1/analytics/benchmark/fetch benchmark.ts
GET /v1/analytics/dashboards dashboards.ts
POST /v1/analytics/dashboards dashboards.ts
GET /v1/analytics/dashboards/:id dashboards.ts
PATCH /v1/analytics/dashboards/:id dashboards.ts
DELETE /v1/analytics/dashboards/:id dashboards.ts
GET /v1/analytics/dashboards/:id/data dashboards.ts
POST /v1/analytics/dashboards/:id/status dashboards.ts
POST /v1/analytics/dashboards/:id/widgets dashboards.ts
DELETE /v1/analytics/dashboards/:id/widgets/:widgetId dashboards.ts
GET /v1/analytics/export benchmark.ts
GET /v1/analytics/kpis kpis.ts
POST /v1/analytics/kpis kpis.ts
PATCH /v1/analytics/kpis/:id kpis.ts
DELETE /v1/analytics/kpis/:id kpis.ts
GET /v1/analytics/kpis/:id/definition kpis.ts
POST /v1/analytics/kpis/:id/thresholds kpis.ts
DELETE /v1/analytics/kpis/:id/thresholds/:thresholdId kpis.ts
GET /v1/analytics/kpis/:name kpis.ts
POST /v1/analytics/queries queries.ts
GET /v1/analytics/queries/saved queries.ts
POST /v1/analytics/queries/saved queries.ts
GET /v1/analytics/queries/saved/:id queries.ts
PATCH /v1/analytics/queries/saved/:id queries.ts
DELETE /v1/analytics/queries/saved/:id queries.ts
POST /v1/analytics/queries/saved/:id/execute queries.ts
POST /v1/analytics/reports/generate reports.ts
GET /v1/analytics/reports/scheduled reports.ts
POST /v1/analytics/reports/scheduled reports.ts
GET /v1/analytics/reports/scheduled/:id reports.ts
PATCH /v1/analytics/reports/scheduled/:id reports.ts
DELETE /v1/analytics/reports/scheduled/:id reports.ts
POST /v1/analytics/reports/scheduled/:id/status reports.ts
POST /v1/analytics/reports/scheduled/:id/trigger reports.ts
GET /v1/analytics/reports/scheduled/due reports.ts

Public API

Section titled “Public API”

Über den Modul-Index (src/index.ts) exportierte Symbole — die einzige erlaubte Zugriffsart von außen:

  • // Aggregate Roots Dashboard
  • // DTOs - Benchmark IngestBenchmarkInput
  • // DTOs - Dashboard CreateDashboardInput
  • // DTOs - KPI CreateKpiInput
  • // DTOs - Query CreateSavedQueryInput
  • // DTOs - Report CreateScheduledReportInput
  • // Dashboard transitions canTransitionDashboard
  • // Enums - Benchmark BenchmarkMetric
  • // Enums - Dashboard DashboardStatus
  • // Enums - KPI KpiCategory
  • // Enums - Query / Report QueryMode
  • // Report transitions canTransitionReport
  • // Result Types KpiValueResult
  • // Schedule Helpers nextScheduledRun
  • // Threshold Evaluation evaluateThreshold
  • // Time Intelligence now
  • // Validations - Benchmark isValidBenchmarkMetric
  • // Validations - Common isValidTimestamp
  • // Validations - Composite isValidWidgetFilter
  • // Validations - Dashboard isValidDashboardStatus
  • // Validations - KPI isValidKpiCategory
  • // Validations - Query / Report isValidQueryMode
  • // Value Objects - Benchmark BenchmarkPoint
  • // Value Objects - Dashboard WidgetFilter
  • // Value Objects - KPI KpiThreshold
  • // Value Objects - Query QueryColumn
  • // Value Objects - Schedule ScheduleConfig
  • ANALYTICS_EVENT_TYPES
  • ANALYTICS_ROLE_NAMES
  • AddThresholdInput
  • AddWidgetInput
  • AggregationType
  • AggregationTypeValidationError
  • AnalyticsRoleName
  • AuditClient
  • AuditEntry
  • BenchmarkClient
  • BenchmarkMetricValidationError
  • BenchmarkNotFoundError
  • BenchmarkPercentile
  • … und 204 weitere

Zurück zur Modul-Übersicht oder zur Startseite.