Optional Utilities
These are useful add-ons, but they are not required to run the main bff-tools workflow.
| Utility | Language | Purpose |
|---|---|---|
utils/bff_browser/app.py | Lightweight local browser for static BFF output | |
utils/bff_portal/backend/api.pl | Backend API for querying BFF data stored in MongoDB | |
utils/bff_portal/frontend/app.pl | Web frontend for the MongoDB-backed BFF portal | |
utils/bff_queue/bff-queue | Queue helper for launching and monitoring repeated jobs | |
utils/bff_queue/minion_ui.pl | Web UI for queue monitoring | |
utils/_models2xlsx/defaultSchema2xlsx.sh | Helper for generating XLSX templates from Beacon model schemas | |
utils/_models2xlsx/csv2xlsx | Converts CSV schema tables into XLSX output |
When To Use Them
- Use
bff_browserwhen you want to inspect static BFF output without MongoDB. - Use
bff_portalwhen your data is already loaded in MongoDB and you want a lightweight query interface. - Use
bff_queuewhen you need to run repeated jobs on a workstation or small server. - Use
_models2xlsxonly when maintaining or regenerating schema-derived XLSX templates.