> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v1.5/setup/configuration/service-configuration/facility-registry.md).
# Facility Registry
## 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
1. Provides APIs to create, update, delete, and search facilities.
2. Provides APIs to bulk create, bulk update, and bulk delete facilities.
## Setup Details
The source code for [Facility](https://github.com/egovernments/health-campaign-services/blob/v1.1.0/docs/health-api-specs/contracts/registries/facility.yml) 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](https://github.com/egovernments/health-campaign-services/blob/v1.1.0/docs/health-api-specs/contracts/registries/facility.yml)
**Application.properties file information*****:***
Kafka topics persister configs for Facility
```
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:
* eGvo mdms :-> egov.mdms.host =[ https://health-dev.digit.org](https://health-dev.digit.org)/
* eGov -idGen :-> egov.idgen.host =[ ](https://health-dev.digit.org)
* eGov-User Service -> egov.user.host =[ ](https://health-dev.digit.org)
## Configuration Details
#### Access MDMS configurations
**Action test: URL actions adding**
[**Action-test.json**](https://github.com/egovernments/health-campaign-mdms/blob/v1.1.0/data/default/ACCESSCONTROL-ACTIONS-TEST/actions-test.json)
```
{
"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**](https://github.com/egovernments/health-campaign-mdms/blob/v1.1.0/data/default/ACCESSCONTROL-ROLEACTIONS/roleactions.json)
```
{
"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](https://github.com/egovernments/health-campaign-config/blob/v1.1.0/egov-persister/facility-persister.yml)
## **Indexer Configuration**
[Facility Indexer Yaml](https://github.com/egovernments/health-campaign-config/blob/v1.1.0/egov-indexer/facility-indexer.yml)
## Database Schema
## **Postman Collection**
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.digit.org/health/v1.5/setup/configuration/service-configuration/facility-registry.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
