Skip to content

Latest commit

 

History

History
166 lines (118 loc) · 9.45 KB

README.md

File metadata and controls

166 lines (118 loc) · 9.45 KB
Raw

Java CI

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:

dps flow

  1. A formated email is sent to an exchange server with an attached image.
  2. DPS Email Poller read the email and extract the image(s) with some metadata.
  3. KOFAX uses DPS Validation Api to validate some data with the destination database server.
  4. KOFAX server uses OCR to extract data from the image documents.
  5. DPS Notification service is called on OCR completion and import the extracted data to a database server.
  6. 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

login into splunk admin:<your password>

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 Swagger
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