From 7693289d4d58a0bcd1f5da4405c9cedfcf07d1ce Mon Sep 17 00:00:00 2001 From: djuarezgf <46350150+djuarezgf@users.noreply.github.com> Date: Tue, 10 Jun 2025 11:03:18 +0200 Subject: [PATCH] docs: add Teiler and Exporter to the main README.md (#315) Co-authored-by: Tobias Kussel --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index f2a7839..bc3e1db 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,9 @@ This repository is the starting point for any information and tools you will nee - [BBMRI-ERIC Directory entry needed](#bbmri-eric-directory-entry-needed) - [Directory sync tool](#directory-sync-tool) - [Loading data](#loading-data) + - [Teiler (Frontend)](#teiler-frontend) + - [Data Exporter Service](#data-exporter-service) + - [Data Quality Report](#data-quality-report) 4. [Things you should know](#things-you-should-know) - [Auto-Updates](#auto-updates) - [Auto-Backups](#auto-backups) @@ -379,6 +382,36 @@ Normally, you will need to build your own ETL to feed the Bridgehead. However, t You can find the profiles for generating FHIR in [Simplifier](https://simplifier.net/bbmri.de/~resources?category=Profile). +### Teiler (Frontend) + +Teiler is the web-based frontend of the Bridgehead, providing access to its various internal, and external services and components. +To learn how to integrate your custom module into Teiler, please refer to https://github.com/samply/teiler-dashboard. +- To activate Teiler, set the following environment variable in your `.conf` file: + +```bash +ENABLE_TEILER=true +``` + +### Data Exporter Service + +The Exporter is a dedicated service for extracting and exporting Bridgehead data in (tabular) formats such as Excel, CSV, Opal, JSON, XML, ... +- To enable the Exporter service, set the following environment variable in your `.conf` file: + +```bash +ENABLE_EXPORTER=true + +#### Data Quality Report +To assess the quality and plausibility of your imported data, the Reporter component is pre-configured to generate Excel reports with data quality metrics and statistical analyses. Reporter is part of the Exporter and can be enabled by setting the same environment variable in your `.conf` file: +```bash +ENABLE_EXPORTER=true +``` + +For convenience, it's recommended to enable the Teiler web frontend alongside the Exporter to access export and quality control features via a web interface: set the following environment varibles in your `.conf` file: +```bash +ENABLE_TEILER=true +ENABLE_EXPORTER=true +``` + ## Things you should know ### Auto-Updates