NEDSS-Modernization

About

Application

• Modernization API - Provides backend services and endpoints to support the searching and management of patients, requests related to configuration, user information, value sets, and other core functionalities required by the frontend and other services.
• Modernization UI
• Question Bank - Provides the backend services and endpoints for to support modernized Page Builder.
• NBS Gateway - A reverse proxy and routing layer for the NEDSS Modernization project. It directs incoming requests to the appropriate backend services (such as Modernization UI, Modernization API, and Question bank), enabling seamless integration between both the modernized and pre-existing frontend, and multiple backend services.

Libraries

Reusable code is organized into three main types:

• Feature libraries provide modular endpoints or features that can be integrated into applications.
• Utility libraries offer shared components for common tasks and standardized interactions with NBS database, and security model.
• Testing libraries supply tools and mock servers to support automated testing across modernization services.

These categories help maintain a clear separation of concerns and promote code reuse throughout the project.

Feature libraries

Standalone modules that provide specific endpoints or features (e.g., configuration, user info, value sets, redirects) which can be packaged within other applications.

• Configuration - An endpoint to expose externalized configuration to the modernization-ui.
• Me-api - An endpoint that provides information about the currently logged-in user.
• Options-api - Provides endpoints to retrieve the contents of value sets.
• Redirect - A generic endpoint to handle transitions from wildfly to spring-boot based services.

Utility libraries

Shared components that offer common utilities and standardized interactions with NBS data and the WildFly application, such as auditing, authentication, authorization, data flattening, and session propagation.

• Accumulation - Flattening the results of select statements that join multiple tables into single objects or lists of objects grouped by a common identifier.
• Audit - Standardizes the auditing fields on NBS tables
• Authentication - An adapter that incorporate the NBS security model in Spring Security.
• Authorization - Allows resolution of the object / operation specific NBS permissions.
• Change - Resolves changes between disparate collections of items representing the same underlying models.
• Classic Interaction - Propagates the session associated with a user when transitioning between wildfly and spring-boot based services.
• Database-Entities
• Event-Schema
• Id Generator - A Java implementation of the getNextUid_sp stored procedure used to create identifiers within NBS.
• Web - Standardizes handling of Cookie management and provides a common Response pattern.

Testing libraries

Modules that implement reusable feature test steps and mock servers to support automated testing across modernization services, including user setup, database containers, HTTP response verification, and test data management.

• Auth and Auth Cucumber - Enables feature test steps for establishing users and permissions.
• Classic Interaction Cucumber - A mock server to verify interactions with wildfly.
• Database - Testcontainer support for the nbs-mssql container.
• HTTP Interaction - Enables feature test steps to verify the status and body of HTTP Responses.
• Identity - An in memory implementation of the NBS ID Generator to reduce database activity during tests.
• Support - An API to make referencing data created for tests.

Development

The CDC Sandbox provides containers to support local development.

Guidelines

• Package by Feature to make code easier to find.
• Code Formatting
• Pull requests

Configuring local development secrets

Some containers within the cdc-sandbox directory require sensitive values be set prior to building.

Container	Required environment variable
nbs-mssql	DATABASE_PASSWORD
nifi	NIFI_PASSWORD, DATABASE_PASSWORD
keycloak	KEYCLOAK_ADMIN_PASSWORD

Running everything inside docker

1. Gain access to the NBS source code repository this is required to build the wildfly container

2. Navigate to the cdc-sandbox directory

   cd cdc-sandbox

3. Run the build_all.sh script

   ./build_all.sh

4. Visit the NBS Login page

   username: msa
   password:
   

5. To create your own user account:

   • Navigate to System Management
   • Expand Security Management
   • Click Manage Users & click Add
   • Enter userId, First Name and Last Name
   • Add a Role(s) & click submit

To learn more about the build process view the cdc-sandbox README

Running the Modernization API and UI in development mode

1. Navigate to the cdc-sandbox directory

   cd cdc-sandbox

2. Start the database and Elasticsearch containers

   docker compose up -d nbs-mssql elasticsearch

3. Navigate to the root directory

   cd ..

4. Start the modernized-api Port 5005 will be open for debugger attachment.

   ./gradlew :modernization-api:bootRun

5. Navigate to the modernization-ui folder

   cd apps/modernization-ui/

6. Launch the modernization-ui

   npm run start

7. Access the UI

Print Artifact Version

./gradlew printVersion


> Task :printVersion
Version: 1.0.0-SNAPSHOT

Running with local servers

The nbs-gateway container is configured to route to the containerized services. Routing to a local service can be achieved by altering the configuration to point to the local instances.

Name	Default	Description
MODERNIZATION_UI_SERVER	modernization-ui	The host name of the server that provides the frontend UI.
MODERNIZATION_UI_PORT	80	The port the frontend UI is served from.
MODERNIZATION_API_SERVER	modernization-api	The host name of the server that provides the backend API.
MODERNIZATION_API_PORT	8080	The port that modernization-api is served from.
PAGEBUILDER_API	pagebuilder-api	The host name of the server that provides the page-builder API.
PAGEBUILDER_API_PORT	8095	The port that page-builder is served from.
NBS_GATEWAY_SERVER	nbs-gateway	The host name of the server that provides the NBS Gateway.
NBS_GATEWAY_PORT	8000	The port the NBS Gateway is served from.

flowchart TD
    subgraph External
        User[User]
    end

    subgraph NBS7
        GW[nbs-gateway]
        M[modernization-api/moderniztion-ui]
        PB[pagebuilder-api]
        ES[(elasticsearch)]
        DB[(nbs-mssql)]
        WF(wildfly)
    end

    User --> GW

    GW --routes--> M
    GW --routes--> PB
    GW --routes--> WF

    M --read/write--> DB
    M --read/write--> ES
    M --request--> WF

    PB --read/write--> DB
    PB --request--> WF

    style GW fill:#8168b3,stroke:#333,stroke-width:2px
    style M fill:#1a4480,stroke:#333,stroke-width:2px
    style PB fill:#28a0cb,stroke:#333,stroke-width:2px
    style DB fill:#565c65,stroke:#333,stroke-width:2px
    style ES fill:#565c65,stroke:#333,stroke-width:2px
    style WF fill:#c05600,stroke:#333,stroke-width:2px

Loading

Configuring the NBS-Gateway to use local modernization-ui

1. Start the frontend UI locally by running the following command from the apps/modernization-ui folder.

   npm run start

2. Start the nbs-gateway container configured to route to the local modernization-ui by executing the following command from the root folder

   MODERNIZATION_UI_SERVER=host.docker.internal MODERNIZATION_UI_PORT=3000 docker compose up -d nbs-gateway

Configuring the NBS-Gateway to use a local modernization-api

From the root folder.

1. Start the backend API locally listening on port 9080 from the root project folder. The nbs-gateway container is accessible from port 8080, which is the default port for the modernization-api. It must be changed in order for the backend to start properly.

   ./gradlew :modernization-api:bootRun --args='--server.port=9080'

2. Start the nbs-gateway container configured to route to the local modernization-api by executing the following command.

   MODERNIZATION_API_SERVER=host.docker.internal MODERNIZATION_API_PORT=9080 docker compose up -d nbs-gateway

Configuring the NBS-Gateway to use a local pagebuilder-api

From the root folder.

1. Start the local pagebuilder-api service.

   ./gradlew :question-bank:bootRun'

2. Start the nbs-gateway container configured to route to the local pagebuilder-api by executing the following command.

   PAGEBUILDER_API=host.docker.internal PAGEBUILDER_API_PORT=8095 docker compose up -d nbs-gateway

Resetting to Docker only

Start the nbs-gateway container by running the following command from the root folder

docker compose up -d nbs-gateway