Vendor Registry Service
Overview
Vendor Registry is a system that enables ULBEmployees to create and search Vendor i.e Desluding Operator (DSO) and driver entities with appropriate vehicle Entities for FSM Application. This document contains the details about how to setup the Vendor 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 vendor-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-mdms-service
egov-user-service
boundary-service
vehicle
Key Functionalities
Added payment payment preference and agency attributes for DSO
Added gender attribute in the create and update APIs for Vendor
Updated the Vendor search API to added vehicleCapacity in the search parameter to search all vendors matching the vehicle capacity specified in the search parameter.
Deployment Details
Deploy the latest version of vendor
Add vendor-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.
Integrate the following below changes in vendor-persister.yml
https://github.com/egovernments/configs/commit/95dd26f926ec44d07448926ee4b6b7e031847a57
Configuration Details
MDMS Configuration
NA
Business Service / Workflow Configuration
NA
Actions & Role Action Mapping
After adding Actions and role-action mappings , restart the egov-mdms-service
Actions
Role Action Mapping
Infra Ops Configuration
Configurations that we can manage through values.yml of vendor in infraops repo as follows values.yml for vehicle can be found
Description | name in values.yml | Current Value |
Kafka Consumer Group | SPRING_KAFKA_CONSUMER_GROUP_ID | egov-vendor-services |
kafka topic to which service push data to save new Vendor | PERSISTER_SAVE_VENDOR_TOPIC | save-vendor-application |
mdms service host | EGOV_MDMS_HOST | egov-mdms-service from egov-service-host |
Vehicle Service host | EGOV_VEHICLE_HOST | vehicle from egov-service-host |
User service host | EGOV_USER_HOST | egov-user-service from egov-service-host |
Location Service Host | EGOV_LOCATION_HOST | egov-location from egov-service-host |
|
|
|
Configurations sample in Values.yml
Data Setup
DSO for FSM System is a vendor, For every city/ULB DSO should be created with the Representative details as owner, associated vehicles and drivers
Sample Curl
Integration
Integration Scope
Any system or digit module can integrated with Vendor Service, helps to manage the Vendor with the vehicles, drivers and owner for representative and login for the representative/owner to login into the system to carry our role specific operations
Integration Benefits
Validation of DSO/Vendor availability
Fetch the vehicle assigned to the DSO
Fetch the Drivers assigned to the DSO
Steps to Integration
FSM to call vendor/v1/_search to fetch the DSO’s
FSM can call vendor/v1/_search to fetch the DSO’s and the respective vehicles and drivers
Interaction Diagram
TBD
Reference Docs
API List
Link | |
/vendor/v1/_create | |
/vendor/v1/_search | |
/vendor/v1/_plainsearch |
Last updated