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.
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.
.
├── .github # Contains GitHub Related sources
├── openshift # openshift templates and pipeline
├── src/ # application source files
│ ├── dps-email-poller/ # DPS Email Poller service
│ ├── dps-email-worker/ # DPS Email worker service
│ ├── dps-notification-service/ # DPS Notification service
│ ├── dps-validation-service/ # DPS DFCM service
│ ├── report/ # Code Coverage Reporter
│ ├── vips-notification-worker/ # VIPS Notification worker
│ └── libs # DPS service api
│ ├── dfcms-ords-client/ # DFCM ords client
│ ├── dps-bom/ # DPS BOM
│ ├── dps-cache-starter/ # DPS cache spring starter
│ ├── dps-commons/ # DPS commons
│ ├── dps-email-client/ # DPS email client
│ ├── dps-files/ # DPS files
│ ├── dps-messaging-starter/ # DPS messaging starter
│ ├── dps-monitoring/ # DPS monitoring
│ ├── dps-sftp-starter/ # DPS sftp starter
│ ├── dps-notification/ # DPS Notification
│ ├── figaro-ords-client/ # Deprecated
│ └── jag-vips-client # Linked repo https://github.com/bcgov/jag-vips-client
├── tests # Tests files
├── docker-compose.yml # docker compose definition
├── LICENSE # Apache License
└── README.md # This file.
Install Docker
Create a .env file based of .env.template and choose a password for splunk
run
docker-compose up dps-splunklogin 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| Name | Doc | Notes | Swagger |
|---|---|---|---|
| Payment Service | Doc | payment-service.swagger.yml | |
| CRRP Notification Worker | Doc | ||
| DPS Notification Service | Doc | ||
| DPS Validation Service | Doc | ||
| VIPS Notification Worker | Doc |
| URL | Method | Description |
|---|---|---|
| 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 | --- |
We use SemVer for versioning. For the versions available, see the release on this repository.
Run
mvn versions:set -DartifactId=* -DgroupId=*
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 newmanRun the collection
cd tests/postman
newman run DPS-Service-Api.postman_collection.json -e dps-local-env.postman_environment.jsonRun 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.jsonFig validation service