The SNOMED Reporting UI (Rep UI) is an Angular-based single-page web application that provides a rich user experience for running, monitoring and analysing SNOMED CT clinical content reports. It acts as the front-end façade to the broader SNOMED International Reporting Platform and communicates with an ecosystem of backend micro-services—Reporting-Service, Reporting Engine, Release-Service, Authoring-Services, Snowstorm, Template-Service and others—via RESTful APIs secured through the organisation’s SSO layer.
This document explains how to run Rep UI locally and the engineering best-practices expected when contributing to the code-base.
flowchart TD
Browser["User's Browser"] --> RepUI["Reporting UI (Angular SPA)"]
RepUI -->|REST| ScheduleManager[(Schedule Manager)]
RepUI -->|REST| ReportingEngine[(Reporting Engine)]
RepUI -->|REST| ReleaseService[(Release Service)]
RepUI -->|REST| AuthoringServices[(Authoring Services)]
RepUI -->|REST| Snowstorm[(Snowstorm Term Server)]
RepUI -->|REST| TemplateService[(Template Service)]
RepUI -->|REST| Auth[(SSO / Auth Service)]
sequenceDiagram
participant User
participant RepUI as UI
participant SM as ScheduleManager
participant RE as ReportingEngine
User->>UI: Configure & Trigger Report (REST)
UI->>SM: POST /jobs/Report/{name}/runs
SM-->>UI: 201 Created (Run ID)
UI-->>User: Run queued
SM->>RE: Execute report
RE-->>SM: Results archive & metrics
UI->>SM: Poll /runs/{id} (or WebSocket in future)
SM-->>UI: Status updates (Queued→Running→Complete)
UI-->>User: Visualise results, download files
Key points:
- Stateless SPA – all state is maintained server-side enabling horizontal scaling behind a CDN.
- Configurable API base-paths allow Rep UI to run behind a reverse proxy in any environment.
- RxJS subjects & async pipes power real-time queue and notification components.
- Built with Angular 19, Bootstrap 5 & Angular Material, packaged by the Angular CLI.
- Modern Angular 19 code-base – strict TypeScript, standalone components and functional routing.
- SSO-secured HTTP interceptors – automatic JWT forwarding & renewal.
- Queue panel & live status indicators – driven by
QueueService(src/app/services/queue). - Report wizard & results explorer – create, re-run, download & delete report runs.
- Integration points
- Reporting-Service endpoints (
/reporting-service/...) - Release-Service endpoints (
/release-service/...) - Authoring-Services & Snowstorm endpoints (
/authoring-services/...,/snowstorm/...) - Template-Service for reusable report templates.
- Reporting-Service endpoints (
- Rich component library utilising Angular Material, ngx-bootstrap, FontAwesome & Toastr.
- Cypress E2E test-suite with Mochawesome reporting.
- ESLint enforced via pre-commit hooks.
src/
app/ ← Angular application sources
components/ ← presentational & components
services/ ← API clients, authentication, utilities
models/ ← TypeScript interfaces & data models
pipes/ ← custom pipes
interceptors/ ← HTTP interceptors (auth, error-handling)
assets/ ← static assets & SCSS
environments/ ← build-time environment configs
cypress/ ← end-to-end tests
Package conventions:
componentsstand-alone UI building blocks.servicesHTTP clients, business logic & shared singletons.interceptorsrequest/response cross-cutting concerns.modelsType definitions shared across the app.
- Node.js 22 LTS (or newer)
- npm 9 (ships with Node) or Yarn Classic
- (Optional) Angular CLI globally:
npm i -g @angular/cli - Running instances (or mocks) of the backend services if you want realistic data:
- Reporting-Service, Reporting Engine, Release-Service, Authoring-Services, Snowstorm, etc.
- A stubbed dev proxy can be used instead – see
proxy.conf.json.
git clone https://github.com/IHTSDO/reporting-ui.git
cd reporting-ui
npm ci # deterministic install using package-lock.jsonnpm start # alias for: ng serve --open- The dev-server runs at
http://localhost:4200/with live-reload. - API calls are proxied to
http://localhost:8080/(configurable viaproxy.conf.json).
npm run build:prod # creates dist/reporting-UI/ with hashed assetsArtifacts are ready for static hosting (Nginx, Apache, S3, CloudFront, etc.).
- End-to-end tests –
npx cypress rungenerates Mochawesome HTML reports undercypress/reports/. - Static analysis –
npm run lint(ESLint) & style-lint via pre-commit hooks.
Rep UI is a static web bundle – deploy it to any web-server or CDN.
FROM nginx:1.26-alpine
COPY dist/reporting-UI /usr/share/nginx/html/reporting
COPY nginx.conf /etc/nginx/conf.d/default.conf