Skip to main content

Optional Utilities

These are useful add-ons, but they are not required to run the main bff-tools workflow.

UtilityLanguagePurpose
utils/bff_browser/app.pyPythonLightweight local browser for static BFF output
utils/bff_portal/backend/api.plPerlBackend API for querying BFF data stored in MongoDB
utils/bff_portal/frontend/app.plPerlWeb frontend for the MongoDB-backed BFF portal
utils/bff_queue/bff-queuePerlQueue helper for launching and monitoring repeated jobs
utils/bff_queue/minion_ui.plPerlWeb UI for queue monitoring
utils/_models2xlsx/defaultSchema2xlsx.shShellHelper for generating XLSX templates from Beacon model schemas
utils/_models2xlsx/csv2xlsxPerlConverts CSV schema tables into XLSX output

When To Use Them

  • Use bff_browser when you want to inspect static BFF output without MongoDB.
  • Use bff_portal when your data is already loaded in MongoDB and you want a lightweight query interface.
  • Use bff_queue when you need to run repeated jobs on a workstation or small server.
  • Use _models2xlsx only when maintaining or regenerating schema-derived XLSX templates.