Vehicle Registry v1.0

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

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 restart egov-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"
        }
    ]
}

Business Service / Workflow Configuration

Workflow configuration for VehicleTrip of FSM

Actions & Role Action Mapping

Actions

Role Action Mapping

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

Description	name in values.yml	Current Value
id-gen host, to generate the application number	`EGOV_IDGEN_HOST`	`egov-idgen` from `egov-service-host`
mdms service host	`EGOV_MDMS_HOST`	`egov-mdms-service` from `egov-service-host`
workflow v2 service host	`WORKFLOW_CONTEXT_PATH`	`egov-workflow-v2` from `egov-service-host`
user service host, to get the locale data	`EGOV_USER_HOST`	`egov-user` from `egov-service-host`
Kafka Consumer Group	`SPRING_KAFKA_CONSUMER_GROUP_ID`	`egov-vehicle-services`
kafka topic to which service push data to save new vehicle application	`PERSISTER_SAVE_VEHICLE_TOPIC`	`save-vehicle-application`
kafka topic to which service push data of the vehicleTrip to save	`PERSISTER_SAVE_VEHICLE_TRIP_TOPIC`	`save-vehicle-trip`
kafka topic to which service push data of the vehicleTrip to update	`PERSISTER_UPDATE_VEHICLE_TRIP_TOPIC`	`update-vehicle-trip`
kafka topic to which service push data of the vehicleTrip to update the status	`PERSISTER_UPDATE_VEHICLE_TRIP_WORKFLOW_TOPIC`	`update-workflow-vehicle-trip`
VehicleTrip Appilcatiion Number format`	`egov.idgen.vehicle.trip.applicationNum.format`	`"[CITY.CODE]-VT-[cy:yyyy-MM-dd]-[SEQ_EGOV_VEHICLETRIP]"`

Configurations sample in Values.yml

Data Setup

Create Vehicle

Create Vehicle with the one of the vehicleType available in the VehicleMakeModel MDMS

Sample Curl

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/_search to validate the fsm vehicle assignment
FSM Application call vehicle/trip/v1/_create on assigning vehicle to the Application
FSTP operator can mark the vehicleTrip as DISPOED.

Interaction Diagram

TBD

Reference Docs

Doc Links

Title	Link
Workflow Technical Document	Workflow Service
User Technical Document	User Service
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	API Contract
Postman Scripts	Postman Collection

API List

Title	Link
`vehicle/v1/_create`	https://www.getpostman.com/collections/d2541409b9570e53ed26
`vehicle/v1/_search`	https://www.getpostman.com/collections/d2541409b9570e53ed26
`/vehicle/v1/_plainsearch`	https://www.getpostman.com/collections/8ad9bc0adf8a22d48ae5
`vehicle/trip/v1/_create`	https://www.getpostman.com/collections/d2541409b9570e53ed26
`vehicle/trip/v1/_update`	https://www.getpostman.com/collections/d2541409b9570e53ed26
`vehicle/trip/v1/_search`	https://www.getpostman.com/collections/d2541409b9570e53ed26
`/vehicle/trip/v1/_plainsearch`	https://www.getpostman.com/collections/8ad9bc0adf8a22d48ae5