hmpps-workload

This is the HMPPS Workload service. This is used to serve workload information about Probation Practitioners

Instructions

To run locally use docker to create a Postgres instance with the following command:

docker-compose up -d

Then execute the command

./gradlew bootRun

testing

These tests are defaults from the template, and the app only serves to run the flyway scripts. This allows you to test that the scripts work locally against postgresql in docker

docker-compose up -d
./gradlew clean check

Code style & formatting

./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook

will apply ktlint styles to intellij and also add a pre-commit hook to format all changed kotlin files.

Events Published

Once a CRN and Conviction is allocated to a new officer in a team the following event types are emitted:

• person.community.manager.allocated
• event.manager.allocated
• requirement.manager.allocated

with the following structure:

{
  "eventType": "{event_type}",
  "version": 1,
  "description": "{description}",
  "detailUrl": "https://{hmpps_workload_url}/allocation/person/{allocationId}",
  "occurredAt": "{createdDate}",
  "additionalInformation": {
    "allocationId": "{allocationId}"
  },
  "personReference": {
    "identifiers": [
      {"type": "CRN", "value":"{crn}"}
    ]
  }
}