https://github.com/cdcgov/nedss-nndss

https://github.com/cdcgov/nedss-nndss

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: CDCgov
  • License: apache-2.0
  • Language: Java
  • Default Branch: main
  • Size: 1.36 MB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 3
  • Open Issues: 2
  • Releases: 8
Created almost 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Contributing License Code of conduct

README.md

NND Overview

This repository houses two NND services; NND dataexchange and NND data poll. These 2 services support the outbound processes and provide support for the STLT to pull transport data from CDC cloud hosted NBS database via HTTPs endpoint and The Poller serivce allow the STLT to periodically calls the HTTPs endpoint to pull the data on the configurable scheduler. This architecture ensure the STLT can make a secure connection to CDC database without depending on third party tool such as Rhapsody.

Services Overview

  • Data Exchange API Service Requirement
    • Java 21
    • Keycloak for security
  • Data Poller Service Requirement
    • Java 21

Environment variable

  • Data Exchange API Service ENV:
    • NBS_DBPASSWORD: DB info
    • NBS_DBSERVER: DB info
    • NBS_DBUSER: DB info
    • NNDAUTHURI: Keycloak info
  • Data Poller Service ENV:
    • NNDDECLIENT_ID: Keycloak client ID
    • NNDDESECRET: Keycloak client Secret
    • NNDDEDE: Data Exchange Endpoint (ex: /api/nnd/data-exchange)
    • NNDDETOKEN: Data Exchange Endpoint (ex: /api/auth/token)
    • NNDDEURL: Data Exchange Url (ex: localhost)
    • NNDFILELOCATION: Path to log directory on the setup machine (ex: /Users/UserName/Desktop/LOG)
    • OP_DBPASSWORD: On Prem DB info
    • OP_DBSERVER: On Prem DB info
    • OP_DBUSER: On Prem DB info
    • NBSNNDCRON: Cron Scheduler (ex: * * * * * *)
    • NBSNNDCRONTIMEZONE: Cron timezone (ex: UTC)
      • API Retry Property
        • APIMAXRETRY: number of retry per api request, default is 5
        • APIRETRYDELAY_MS: delay time before execute the next call, default is 3000 ms (3 seconds)
        • APISTUCKTHRESHOLD_MINUTE: time to trigger token refresh when token is expired, default is 10 min - recommend using default
        • APIMAXBACKOFF: max exponential backoff for max delay time. Default is 60000 ms (1 min). This used in combined with the APIRETRYDELAY_MS
        • If Delay is 3 second and Back off is 1 min and there 5 retry - each retry deploy will be increase by multiply of 2 until it reaching 1 minute. For 3 second, first delay is 3 sec, then 6 sec, then 12 sec, so on and on until it cap at 60 min
  • NETSS Message Processor ENV:
    • NBSNNDCRON: Cron Scheduler (ex: * * * * * *)
    • NETSSFILELOCATION: Path to output directory on the setup machine (ex: /Users/UserName/Desktop/LOG)
    • NETSS_PRIOR: prior date indicator (ex: either T or F)
    • NETSS_DATE: date value (format: 12/30/2023)
    • OP_DBPASSWORD: On Prem DB info
    • OP_DBSERVER: On Prem DB info
    • OP_DBUSER: On Prem DB info

Useful command to run Poller jar file

The two enviroment variable the end user will need to explicitly set when running the poller service is the CRON configuration (NBSNNDCRON (schedule) and NBSNNDCRONTIMEZONE (timezone)) - Mac - export ENVVAR=value - java -jar build/libs/nnd-data-poll.jar - Linux - export ENVVAR=value - java -jar build/libs/nnd-data-poll.jar - Windows - User can explicitly set the ENV in environment configuration or it also can be on terminal as follow - set ENV=value - java -jar build/libs/nnd-data-poll.jar - Java command - java -Denv=value -jar build/libs/nnd-data-poll.jar

Owner

  • Name: Centers for Disease Control and Prevention
  • Login: CDCgov
  • Kind: organization
  • Email: data@cdc.gov
  • Location: Atlanta, GA

CDC's collaborative software projects to protect America from health, safety, and security threats, both foreign and in the U.S.

GitHub Events

Total
  • Release event: 5
  • Delete event: 49
  • Member event: 4
  • Issue comment event: 162
  • Push event: 252
  • Pull request event: 136
  • Pull request review comment event: 21
  • Pull request review event: 83
  • Fork event: 5
  • Create event: 91
Last Year
  • Release event: 5
  • Delete event: 49
  • Member event: 4
  • Issue comment event: 162
  • Push event: 252
  • Pull request event: 136
  • Pull request review comment event: 21
  • Pull request review event: 83
  • Fork event: 5
  • Create event: 91

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 2
  • Total pull requests: 159
  • Average time to close issues: 2 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.77
  • Merged pull requests: 124
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 141
  • Average time to close issues: 2 days
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 5
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.79
  • Merged pull requests: 107
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • ndduc01 (151)
  • ssathiah (26)
  • sralla-eq (15)
  • rshanmugam-enquizit (15)
  • szamfir (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

docker-compose.yml docker
nnd-data-exchange-service/Dockerfile docker
  • amazoncorretto 17 build
nnd-data-exchange-service/build.gradle maven
  • org.projectlombok:lombok * compileOnly
  • com.google.code.gson:gson 2.10.1 implementation
  • com.microsoft.sqlserver:mssql-jdbc 12.2.0.jre11 implementation
  • com.zaxxer:HikariCP 5.0.1 implementation
  • org.apache.httpcomponents.core5:httpcore5 5.2.5 implementation
  • org.springdoc:springdoc-openapi-starter-webmvc-ui 2.3.0 implementation
  • org.springframework.boot:spring-boot-starter-data-jpa * implementation
  • org.springframework.boot:spring-boot-starter-oauth2-resource-server 3.2.0 implementation
  • org.springframework.boot:spring-boot-starter-web * implementation
  • com.nimbusds:oauth2-oidc-sdk 11.8 runtimeOnly
  • org.springframework.boot:spring-boot-starter-test * testImplementation
  • org.springframework.security:spring-security-test 6.2.0 testImplementation
  • org.junit.platform:junit-platform-launcher * testRuntimeOnly
nnd-data-poll-service/build.gradle maven
  • org.projectlombok:lombok * compileOnly
  • com.google.code.gson:gson 2.10.1 implementation
  • com.microsoft.sqlserver:mssql-jdbc 12.2.0.jre11 implementation
  • org.springframework.boot:spring-boot-starter-data-jpa * implementation
  • org.springframework.boot:spring-boot-starter-web * implementation
  • org.springframework.boot:spring-boot-starter-test * testImplementation
  • org.junit.platform:junit-platform-launcher * testRuntimeOnly
.github/workflows/Build-and-deploy-nnd-service.yaml actions
  • actions/checkout v4 composite
  • actions/setup-java v4 composite
  • actions/upload-artifact v4 composite
.github/workflows/Release-container-nnd-service.yaml actions
  • actions/checkout v4 composite
  • actions/setup-java v4 composite
  • actions/upload-artifact v4 composite
.github/workflows/sonar.yaml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-java v4 composite
  • actions/upload-artifact v4 composite
build.gradle maven
netss-message-processor/build.gradle maven
  • org.projectlombok:lombok * compileOnly
  • com.microsoft.sqlserver:mssql-jdbc 12.2.0.jre11 implementation
  • com.zaxxer:HikariCP 5.0.1 implementation
  • org.springframework.boot:spring-boot-starter-data-jpa * implementation
  • org.springframework.boot:spring-boot-starter-web * implementation
  • org.junit.jupiter:junit-jupiter * testImplementation
  • org.junit.jupiter:junit-jupiter-engine * testImplementation
  • org.mockito:mockito-core * testImplementation
  • org.springframework.boot:spring-boot-starter-test * testImplementation
  • org.junit.platform:junit-platform-launcher * testRuntimeOnly