bcgov / jag-dps Goto Github PK

View Code? Open in Web Editor NEW

3.0 18.0 11.0 2 MB

Document Processing Services

License: Apache License 2.0

Java 98.87% Dockerfile 1.13%

ag java spring-boot openshift

jag-dps's Introduction

DPS Document Processing System

DPS is used by the BC Ministry of Justice Department as an integration pipeline to process image documents.

Documents that are sent to a specific email address will be processed by DPS.

A typical DPS flow consists of the following:

A formated email is sent to an exchange server with an attached image.
DPS Email Poller read the email and extract the image(s) with some metadata.
KOFAX uses DPS Validation Api to validate some data with the destination database server.
KOFAX server uses OCR to extract data from the image documents.
DPS Notification service is called on OCR completion and import the extracted data to a database server.
Database server is updated.

Contributing

Before you start have a look at our CODE OF CONDUCT, we are a friendly project, so don't hesitate to give us some feedback!

If you decide to contribute, you can read our CONTRIBUTING GUIDE.

Project Structure

.
├── .github                             # Contains GitHub Related sources
├── configurations                      # 
├── openshift                           # openshift templates and pipeline
├── src/                                # application source files
│   ├── spd-notification-worker/        # SPD Notification Worker
│   ├── dps-notification-service/       # DPS Notification service  
│   ├── dps-validation-service/         # DPS DFCM service
|   ├── figaro-validation-service/      # DPS Figaro Validator service
|   ├── dps-payment-service/                 # DPS payment service
│   └── service-api                     # DPS service api
├── tests                               # Tests files
├── docker-compose.yml                  # docker compose definition
├── LICENSE                             # Apache License
└── README.md                           # This file.

Run

Install Docker

Create a .env file based of .env.template and choose a password for splunk

run

docker-compose up dps-splunk

Enable splunk Http Event Collector and create a token

Update your .env file with the newly created token value and the figaro server information

Install Splunk Addon for NGINX app following this instructions

Restart splunk when prompted

Restart docker-compose with the new changes

docker-compose up --build -d

Dps Service List

Name	Doc	Notes
Payment Service	Doc	payment-service.swagger.yml
CRRP Notification Worker	Doc
DPS Notification Service	Doc
DPS Validation Service	Doc
Figaro Validation Service	Doc
VIPS Notification Worker	Doc

Endpoints

URL	Method	Description
Payment Service	---	---
http://localhost:5050/paymentservice/bamboraconfiguration	GET	Bambora configuration url
http://localhost:5050/paymentservice/getSinglePaymentURL	GET	Single Payment Url
http://localhost:8081/paymentservice/actuator/health	GET	Payment Service Health
http://localhost:8081/paymentservice/swagger-ui.html	GET	Figaro Validator Swagger-UI
http://localhost:8081/paymentservice/v2/api-docs	GET	Figaro Validator Api docs
Figaro Validation	---	---
http://localhost:5050/figvalidationservice/locateMatchingApplicants	GET	Locate Matching Applicants
http://localhost:5050/figvalidationservice/validateApplicantService	GET	Validate Applicant Service
http://localhost:5050/figvalidationservice/validateApplicantForSharing	GET	Validate Applicant Sharing
http://localhost:5050/figvalidationservice/validateApplicantPartyId	GET	Validate Applicant Party ID
http://localhost:8082/figvalidationservice/actuator/health	GET	Figaro Validator Health
http://localhost:8082/figvalidationservice/swagger-ui.html	GET	Figaro Validator Swagger-UI
DPS Validation	---	---
http://localhost:5050/dpsvalidationservice/getValidOpenDFCMCase	GET	Valid Open DFCM Case
http://localhost:8083/dpsvalidationservice/actuator/health	GET	DPS Validation Service Health
http://localhost:8083/dpsvalidationservice/swagger-ui.html	GET	DPS Validation Service Swagger-UI
http://localhost:8083/dpsvalidationservice/v2/api-docs	GET	DPS Validation Service Swagger
DPS Output Notification	---	---
http://localhost:5054/dpsnotificationservice/actuator/health	GET	DPS Notification Service Health
http://localhost:5050/ws/dpsOutputNotification.wsdl	GET	DPS Output Notification Service WSDL
CRRP Notification Worker	---	---
http://localhost:5055/crrpnotificationworker/actuator/health	GET	CRRP Notification
CRRP Notification Worker	---	---
http://localhost:5056/vipsnotificationworker/actuator/health	GET	CRRP Notification

Worker Health | | SUPPORT APPS | --- | --- | | RabbitMq | Rabbit MQ management console | --- | | Splunk | Splunk Web | --- |

Versioning

We use SemVer for versioning. For the versions available, see the release on this repository.

Update Version

Run

mvn versions:set -DartifactId=*  -DgroupId=*

Tests

Postman

We maintain a postman collection and a postman environment.

You can also run the collection using newman

Install newman as a global tool

npm install -g newman

Run the collection

cd tests/postman
newman run DPS-Service-Api.postman_collection.json -e dps-local-env.postman_environment.json

Run the collection with datafile

DPS Validation Service

cd tests/postman
newman run DPS-Service-Api.postman_collection.json -e dps-local-env.postman_environment.json -d get-valid-open-dfcm-case-datafile.json

Fig validation service

 newman run DPS-Service-Api-Fig.postman_collection.json -e dps-local-env.postman_environment.json -d fig-locate-matching-applicants-datafile.json

jag-dps's People

Stargazers

Watchers

Forkers

shaunmillargov alexjoybc smesworld archanasudha taygov kkflood kfloodbcgov nancymz sivakaruna rshourou jianmingtu

jag-dps's Issues

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means its critical that we work to make our content as discoverable as possible; Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

That's in, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

If your org is not in the list below, or the table contains errors, please create an issue here.
While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.
Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.
If your application is live, add the production URL.

Ministry Short Codes

Short Code	Organization Name
AEST	Advanced Education, Skills & Training
AGRI	Agriculture
ALC	Agriculture Land Commission
AG	Attorney General
MCF	Children & Family Development
CITZ	Citizens' Services
DBC	Destination BC
EMBC	Emergency Management BC
EAO	Environmental Assessment Office
EDUC	Education
EMPR	Energy, Mines & Petroleum Resources
ENV	Environment & Climate Change Strategy
FIN	Finance
FLNR	Forests, Lands, Natural Resource Operations & Rural Development
HLTH	Health
FLNR	Indigenous Relations & Reconciliation
JEDC	Jobs, Economic Development & Competitiveness
LBR	Labour Policy & Legislation
LDB	BC Liquor Distribution Branch
MMHA	Mental Health & Addictions
MAH	Municipal Affairs & Housing
BCPC	Pension Corporation
PSA	Public Safety & Solicitor General & Emergency B.C.
SDPR	Social Development & Poverty Reduction
TCA	Tourism, Arts & Culture
TRAN	Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 367 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

If this product is being actively maintained, please close this issue.
If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!