Overview
The facility service provides APIs to create facilities for HCM. This document provides the configuration details for setting up the facility.
Pre-requisites
Knowledge of Java/J2EE (preferably Java 8 version).
Knowledge of spring boot and spring-boot micro-services.
Knowledge of Git or any version control system.
Knowledge of RESTful web services.
Knowledge of the Lombok library is helpful.
Knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-indexer, and eGov-user will be helpful.
Functionalities
Provides APIs to create, update, delete, and search facilities.
Provides APIs to bulk create, bulk update, and bulk delete facilities.
Setup Details
The source code for Facility is present in the health-campaign-services Git repo. The spring boot application needs the Lombok* extension added to the IDE to load it. Once the application is up and running, the API requests can be posted to the URL and the IDs can be generated.
* In the case of IntelliJ, the plugin can be installed directly. For eclipse, the Lombok jar location has to be added in the eclipse.ini file in this format javaagent:lombok.jar.
API details
Refer to the Swagger API for YAML file details: Facility.yaml
Application.properties file information :
Kafka topics persister configs for Facility
Copy facility.consumer.bulk.delete.topic=delete-facility-bulk-topic
facility.consumer.bulk.create.topic=create-facility-bulk-topic
facility.consumer.bulk.update.topic=update-facility-bulk-topic
facility.kafka.create.topic=save-facility-topic
facility.kafka.update.topic=update-facility-topic
facility.kafka.delete.topic=delete-facility-topic
URLs for the external API references:
Configuration Details
Access MDMS configurations
Action test: URL actions adding
Action-test.json
Copy {
"id": 1615,
"name": "Facility Create",
"url": "/facility/v1/_create",
"displayName": "Facility Create",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
},
{
"id": 1616,
"name": "Facility Bulk Create",
"url": "/facility/v1/bulk/_create",
"displayName": "Facility Bulk Create",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
},
{
"id": 1617,
"name": "Facility Update",
"url": "/facility/v1/_update",
"displayName": "Facility Update",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
},
{
"id": 1618,
"name": "Facility Bulk Update",
"url": "/facility/v1/bulk/_update",
"displayName": "Facility Bulk Update",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
},
{
"id": 1619,
"name": "Facility Delete",
"url": "/facility/v1/_delete",
"displayName": "Facility Delete",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
},
{
"id": 1620,
"name": "Facility Bulk Delete",
"url": "/facility/v1/bulk/_delete",
"displayName": "Facility Bulk Delete",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
},
{
"id": 1621,
"name": "Facility Search",
"url": "/facility/v1/_search",
"displayName": "Facility Search",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "facility",
"code": "null",
"path": ""
}
Access to role-based actions
Roleaction.json
Copy {
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1615,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1616,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1617,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1618,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1619,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1620,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1621,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1614,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1615,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1616,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1617,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1618,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1619,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1620,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "WAREHOUSE_MANAGER",
"actionid": 1621,
"actioncode": "",
"tenantId": "default"
},
Persister Configuration
Facility Persister Yaml
Indexer Configuration
Facility Indexer Yaml
Database Schema
Postman Collection
https://www.postman.com/lunar-resonance-126497/workspace/hcm/environment/24751924-61d3084a-c7bf-4591-8b7d-2ec5828d96b1