Project Services

Overview

The stock service provides APIs to manage project, project staff, project beneficiary, project tasks, project resources, and project facilities for HCM. This document provides the configuration details for setting up the project.

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

  1. Provides APIs to create, update, delete, and search projects.

  2. Provides APIs to create, update, delete, and search project beneficiaries.

  3. Provides APIs to bulk create, bulk update, and bulk delete project beneficiaries.

  4. Provides APIs to create, update, delete, and search project facilities.

  5. Provides APIs to bulk create, bulk update, bulk delete project facility.

  6. Provides APIs to create, update, delete, and search project staff.

  7. Provides APIs to bulk create, bulk update, and bulk delete project staff.

  8. Provides APIs to create, update, delete and search project tasks.

  9. Provides APIs to bulk create, bulk update, and bulk delete project tasks.

  10. Provides APIs to create, update, delete, and search project resources.

  11. Provides APIs to bulk create, bulk update, and bulk delete project tasks.

Setup details

The source code for the Project 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. Link - Project.yaml

Application.properties file information:

Kafka topics persister configs for projects

URLs for the external API references:

Configuration details

Access MDMS configurations

Action test: URL actions adding

Action-test.json

Access to role-based actions

Roleaction.json

Persister Configuration

Project Persister Yaml

Indexer Configuration

Project Indexer Yaml

Database Schema

Postman Collection

https://www.postman.com/lunar-resonance-126497/workspace/hcm/environment/24751924-61d3084a-c7bf-4591-8b7d-2ec5828d96b1

Was this helpful?