> For the complete documentation index, see [llms.txt](https://jembi.gitbook.io/openhim-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-elasticsearch/local-development.md).

# Local Development

### Launching

Launching this package follows different steps: 

* \[Cluster mode] Creating certificates and configuring the nodes 
* Running Elasticsearch
* Setting Elasticsearch passwords
* Importing Elasticsearch index

### Importing

To initialize the index mapping in Elasticsearch, a helper container is launched to import a config file to Elasticsearch. The config importer looks for a field named `fhir-enrich-report.json` in `<path to project packages>/analytics-datastore-elastic-search/importer`.

The file `fhir-enrich-report.json` will contain the mapping of the index `fhir-enrich-reports`.&#x20;

Elasticsearch will create a dynamic mapping for the incoming data if we don't specify one, this dynamic mapping may cause issues when we start sending the data as it doesn't necessarily conform 100% to the data types that we're expecting when querying the data out of Elasticsearch again.

Therefore, the mapping should be initialized in Elasticsearch using the config importer.&#x20;

The file `fhir-enrich-report.json` is just an example, the name and the mapping can be overridden.

### Running in Dev Mode

When running in DEV mode, Elasticsearch is reachable at:

> `http://127.0.0.1:9201/`

### Elasticsearch Backups

For detailed steps about creating backups see: [Snapshot filesystem repository docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html).

Elasticsearch offers the functionality to save a backup in different ways, for further understanding, you can use this link: [Register a snapshot repository docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html).

### Elasticsearch Restore

To see how to restore snapshots in Elasticsearch: [Snapshot Restore docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-restore-snapshot.html#snapshots-restore-snapshot).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://jembi.gitbook.io/openhim-platform/packages/analytics-datastore-elasticsearch/local-development.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.