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:

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

Endpoints

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