Overview
Vehicle Registry is a system that enables ULB Employees to create and search Vehicle Entities and schedule Vehicle Trip for FSM Application and track the VehicleTrip. This document contains the details about new enhancements made to the Vehicle service as part of FSM v1.1 release and how to setup the Vehicle and describe the functionalities provided.
Pre-requisites
Before you proceed with the configuration, make sure the following pre-requisites are met -
Java 8
Kafka server is up and running
egov-persister service is running and has vehicle-persister config path added in it
PSQL server is running and database is created to store FSM Application data
Following services should be up and running:
egov-perister
egov-mdms-service
egov-workflow-v2
egov-idgen
Key Functionalities
DSO or ULB can create multiple vehicle trips based on the number of trips entered while submitting the FSM application.
FSTPO can decline the vehicle reason with appropriate reason.
Owner attribute has been added to the vehicle
FSTPO Vehicle Log Inbox Enhancements to include Application No search filter so that FSTPO can view all the vehicle trips associated with the application.
FSPTO vehicle log API upgraded to show trip numbers in case of multi-trip application
Deployment Details
Deploy the latest version of vehicle
Add vehicle-persister.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called
persist-yml-path) and restartegov-persister-service.
Configuration Details
MDMS Configuration
Add master data in MDMS service with module name as Vehicle and restart egov-mdms-service. Following is some sample master data for
SuctionType
{
"tenantId": "pb",
"moduleName": "Vehicle",
"SuctionType": [
{
"code": "SEWER_SUCTION_MACHINE",
"name": "Sewer suction machine",
"active": true
},
{
"code": "SEWER_SUCTION_CUM_JETTING_MACHINE",
"name": "Sewer suction cum jetting machine",
"active": true
}
]
}
VehicleOwner
{
"tenantId": "pb",
"moduleName": "Vehicle",
"VehicleOwner": [{
"name": "ULB",
"code": "ULB",
"active": true
},
{
"name": "Private",
"code": "Private",
"active": true
}
]
}
VehicleMakeModel
{
"tenantId": "pb",
"moduleName": "Vehicle",
"VehicleMakeModel": [
{
"code": "MAHINDRA",
"name": "Mahindra",
"active": true
},
{
"code": "MAHINDRA.BOLERO_PICKUP",
"name": "Bolero Pickup",
"active": true,
"make": "MAHINDRA",
"capacity": "5000",
"amount": "500"
},
{
"code": "TATA",
"name": "TATA",
"active": true
},
{
"code": "TATA.LPT709/34",
"name": "TATA LPT709/34",
"active": true,
"make": "TATA",
"capacity": "2000",
"amount": "200"
},
{
"code": "TATA.407",
"name": "TATA 407",
"active": true,
"make": "TATA",
"capacity": "1000",
"amount": "100"
},
{
"code": "TAFE",
"name": "TAFE",
"active": true
},
{
"code": "TAFE.TRACTOR_45DI",
"name": "TAFE Tractor 45DI",
"active": true,
"make": "TAFE",
"capacity": "10000",
"amount": "1000"
},
{
"code": "SONALIKA",
"name": "Sonalika",
"active": true
},
{
"code": "SONALIKA.TRACTOR_35DI",
"name": "Sonalika Tractor 35DI",
"active": true,
"make": "SONALIKA",
"capacity": "8000",
"amount": "1000"
}
]
}
FSTPORejectionReason (Vehicle decline reason codes)
{
"tenantId": "pb",
"moduleName": "Vehicle",
"FSTPORejectionReason": [{
"name": "Septage Source",
"code": "SEPTAGE_SOURCE",
"active": true
},
{
"name": "Outside operational hours",
"code": "OUTSIDE_OPERATIONAL_HOURS",
"active": true
},
{
"name": "Under Maintenance",
"code": "UNDER_MAINTENANCE",
"active": true
},
{
"name": "Others",
"code": "OTHERS",
"active": true
}
]
}
Business Service / Workflow Configuration
Workflow configuration for VehicleTrip of FSM
{
"tenantId": "pb",
"businessService": "FSM_VEHICLE_TRIP",
"business": "vehicle",
"businessServiceSla": 172800000,
"states": [
{
"sla": null,
"state": null,
"applicationStatus": null,
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"action": "SCHEDULE",
"nextState": "SCHEDULED",
"roles": [
"FSM_DSO"
]
}
]
},
{
"sla": null,
"state": "SCHEDULED",
"applicationStatus": "SCHEDULED",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"actions": [
{
"action": "READY_FOR_DISPOSAL",
"nextState": "WAITING_FOR_DISPOSAL",
"roles": [
"FSM_DSO",
"FSM_EDITOR_EMP"
]
}
]
},
{
"sla": null,
"state": "WAITING_FOR_DISPOSAL",
"applicationStatus": "WAITING_FOR_DISPOSAL",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"actions": [
{
"action": "DISPOSE",
"nextState": "DISPOSED",
"roles": [
"FSM_EMP_FSTPO"
]
},
{
"action": "DECLINEVEHICLE",
"currentState": "WAITING_FOR_DISPOSAL",
"nextState": "VEHICLE_DECLINED",
"roles": [
"FSM_EMP_FSTPO"
]
}
]
},
{
"sla": null,
"state": "DISPOSED",
"applicationStatus": "DISPOSED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": true
},
{
"tenantId": "pb",
"sla": null,
"state": "VEHICLE_DECLINED",
"applicationStatus": "VEHICLE_DECLINED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": true
"actions": null
}
]
}
Actions & Role Action Mapping
Actions
{
"id": {{PLACEHOLDER1}},
"name": "Create Vehicle Application",
"url": "/vehicle/v1/_create",
"displayName": "Create Vehicle",
"orderNumber": 0,
"enabled": false,
"serviceCode": "vehicle",
"code": "null",
"path": ""
},
{
"id": {{PLACEHOLDER2}},
"name": "Search Vehicle Application",
"url": "/vehicle/v1/_search",
"displayName": "Search Vehicle",
"orderNumber": 1,
"enabled": false,
"serviceCode": "vehicle",
"code": "null",
"path": ""
},
{
"id": {{PLACEHOLDER3}},
"name": "Vehicle Trip Search",
"url": "/vehicle/trip/v1/_search",
"displayName": "Vehicle Trip Search",
"orderNumber": 1,
"parentModule": "",
"enabled": false,
"serviceCode": "",
"code": "null",
"path": ""
},
{
"id": {{PLACEHOLDER4}},
"name": "Vehicle Trip Update",
"url": "/vehicle/trip/v1/_update",
"displayName": "Vehicle Trip Update",
"orderNumber": 1,
"parentModule": "",
"enabled": false,
"serviceCode": "",
"code": "null",
"path": ""
}
Role Action Mapping
[
{
"rolecode": "FSM_ADMIN",
"actionid": {{PLACEHOLDER1}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_ADMIN",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_DSO",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_EDITOR_EMP",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_VIEW_EMP",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_EMP_FSTPO",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_EMP_FSTPO",
"actionid": {{PLACEHOLDER3}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "FSM_EMP_FSTPO",
"actionid":{{PLACEHOLDER4}},
"actioncode": "",
"tenantId": "pb"
}
]
Infra Ops Configuration
Configurations that we can manage through values.yml vehicle in infraops repo as follows
values.yml for vehicle can be found
Description | name in values.yml | Current Value |
|---|---|---|
id-gen host, to generate the application number |
|
|
mdms service host |
|
|
workflow v2 service host |
|
|
user service host, to get the locale data |
|
|
Kafka Consumer Group |
|
|
kafka topic to which service push data to save new vehicle application |
|
|
kafka topic to which service push data of the vehicleTrip to save |
|
|
kafka topic to which service push data of the vehicleTrip to update |
|
|
kafka topic to which service push data of the vehicleTrip to update the status |
|
|
VehicleTrip Appilcatiion Number format` |
|
|
Configurations sample in Values.yml
egov.idgen.vehicle.trip.applicationNum.format: "[CITY.CODE]-VT-[cy:yyyy-MM-dd]-[SEQ_EGOV_VEHICLETRIP]"
# Additional Container Envs
env: |
- name: EGOV_IDGEN_HOST
valueFrom:
configMapKeyRef:
name: egov-service-host
key: egov-idgen
- name: EGOV_HRMS_HOST
valueFrom:
configMapKeyRef:
name: egov-service-host
key: egov-hrms
- name: EGOV_MDMS_HOST
valueFrom:
configMapKeyRef:
name: egov-service-host
key: egov-mdms-service
- name: EGOV_USER_HOST
valueFrom:
configMapKeyRef:
name: egov-service-host
key: egov-user
- name: WORKFLOW_CONTEXT_PATH
valueFrom:
configMapKeyRef:
name: egov-service-host
key: egov-workflow-v2
- name: WORKFLOW_TRANSITION_PATH
value: "egov-workflow-v2/egov-wf/process/_transition"
- name: EGOV_IDEN_VEHICLE_TRIP_APPLICATIONNUM_FORMAT
value: "[CITY.CODE]-VT-[cy:yyyy-MM-dd]-[SEQ_EGOV_VEHICLETRIP]"
- name: SPRING_KAFKA_CONSUMER_GROUP_ID
value: egov-vehicle-services
- name: PERSISTER_SAVE_VEHICLE_TOPIC
value: save-vehicle-application
- name: PERSISTER_UPDATE_VEHICLE_TOPIC
value: update-vehicle-application
- name: PERSISTER_SAVE_VEHICLE_TRIP_TOPIC
value: save-vehicle-trip
- name: PERSISTER_UPDATE_VEHICLE_TRIP_TOPIC
value: update-vehicle-trip
- name: PERSISTER_UPDATE_VEHICLE_TRIP_WORKFLOW_TOPIC
value: update-workflow-vehicle-trip
- name: SPRING_KAFKA_PRODUCER_KEY_SERIALIZER
value: org.apache.kafka.common.serialization.StringSerializer
- name: SPRING_KAFKA_PRODUCER_VALUE_SERIALIZER
value: org.springframework.kafka.support.serializer.JsonSerializer
- name: JAVA_OPTS
value: {{ index .Values "heap" | quote }}
- name: JAVA_ARGS
value: {{ index .Values "java-args" | quote }}
- name: SERVER_PORT
value: "8080"
- name: SECURITY_BASIC_ENABLED
value: "false"
- name: MANAGEMENT_SECURITY_ENABLED
value: "false"
{{- if index .Values "tracing-enabled" }}
- name: TRACER_OPENTRACING_ENABLED
value: "true"
{{- end }}
Data Setup
Create Vehicle
Create Vehicle with the one of the vehicleType available in the VehicleMakeModel MDMS
Sample Curl
curl --location --request POST 'https://dev.digit.org/vehicle/v1/_create' \
--header 'Content-Type: application/json' \
--data-raw '{
"RequestInfo": {
"apiInfo": {
"id": "string",
"version": "string",
"path": "string"
},
"deviceDetail": {
"id": "string",
"signature": "string"
},
"ts": 0,
"action": "string",
"key": "string",
"msgId": "string",
"requesterId": "string",
"authToken": "a35b5ba7-2d5f-4272-8a67-0303cfab2c9f"
},
"vehicle": {
"tenantId": "pb.amritsar",
"registrationNumber": "TS 09 PA 2466",
"model":"1998",
"type":"TRUCK",
"tankCapacity":"2000",
"suctionType":"SEWER_SUCTION_MACHINE",
"vehicleOwner": "ULB",
"pollutionCertiValidTill":1611584416772,
"InsuranceCertValidTill":1611584416772,
"fitnessValidTill":1611584416772,
"roadTaxPaidTill":1611584416772,
"gpsEnabled":true,
"source":"Municipal records",
"owner": {
"tenantId": "pb.amritsar",
"name": "DSO1",
"fatherOrHusbandName": "Phani",
"relationship": "FATHER",
"gender": "MALE",
"dob": 550261800000,
"emailId": "test@dso.test",
"correspondenceAddress": "KPHB",
"mobileNumber": 8919146630
}
}
}'
Integration
Integration Scope
Integrated with Application through REST API to create, and search vehicles.
For any module where vehicle Trip is required, can integrate REST API trip/v1/create, update, search
Integration Benefits
Vehicle Managed would become easy
Trip Management would become easy
Steps to Integration
FSM Application can
vehicle/v1/_searchto validate the fsm vehicle assignmentFSM Application call
vehicle/trip/v1/_createon assigning vehicle to the ApplicationFSTP operator can mark the vehicleTrip as DISPOED.
Interaction Diagram
TBD
Reference Docs
Doc Links
Title | Link |
Workflow Technical Document | |
User Technical Document | |
MDMS Technical Document | NEEDS TO BE UPDATED |
IDGen Technical Document | NEEDS TO BE UPDATED |
Localization Technical Document | NEEDS TO BE UPDATED |
Persister Technical Document | NEEDS TO BE UPDATED |
SMS Notification Technical Document | NEEDS TO BE UPDATED |
API Contract | |
Postman Scripts |
API List
Title | Link |
| |
| |
| |
| |
| |
| |
|
Add Comment