App/Splash/View

by

Overview

The Splash View is a flexible data exploration tool in myBMT, providing interactive access to various structured data formats, including:

  • CSV
  • JSON
  • Parquet
  • Nested JSON
  • XLSX (including worksheets)
  • API responses (returning JSON results)

This tool allows users to explore data visually and programmatically, ensuring seamless interaction across multiple file formats.

1️⃣ Availability

Where can I find the Splash View?

🚿 Wherever you see the shower icon in myBMT “Shower Me with Data”

  • Appears as [🚿 Show Container]
  • Click it to explore the dataset interactively

🌐 Azure Explore Page in myBMT

  • Provides direct access to stored datasets

These entry points enable seamless access to structured data, whether you’re working with files or catalogue tables.

2️⃣ URL Formats

The Splash View can be accessed using two different URL formats, depending on the use case.

1️⃣ Catalogue Tables & File Objects

Used for accessing predefined catalogue tables or file objects by specifying an id parameter.

http://mybmt/index.php?module=app/splash/view&id=795
  • id=795 → Refers to a specific catalogue table or file object
  • The system retrieves metadata from the catalogue entry to determine the data source

2️⃣ Direct Table Access via Storage Path

Used for accessing files directly from storage.

http://mybmt/index.php?module=app/splash/view
&table=DIM_ABSENCE_TYPE_OL.csv
&host=uks
&cont=ifs
&folder=Import
&env=dev
&rows=100

🔹 Query Parameters

ParameterDescriptionDefault
tableThe name of the table or file to access.Required
hostSpecifies the data host location (e.g., uks).Required
contThe container where the file is stored (e.g., ifs).Required
folderThe folder location inside the container.Import
envThe environment (dev or prd).dev
rowsThe maximum number of rows to fetch.100

3️⃣ API Functionality

A new API function enables retrieving JSON results directly, making it useful for integrations and automation.

if ($view === 'api') {
    header('Content-Type: application/json');
    echo json_encode($tablearray);
    exit;
}
ParameterDescriptionDefault
tableThe name of the endpoint to access.Required
hostSpecifies the data host location (e.g., hubspot).Required
contThe container array in the result (e.g., data).Required
folderThe folder location inside the container.Import
envThe environment (dev or prd).dev
rowsThe maximum number of rows to fetch.100

4️⃣ Features & Functionality

🔹 Interactive Tables with DataTables

  • Uses DataTables for enhanced functionality:
    ✅ Column-based searching
    ✅ Pagination & sorting
    ✅ Export options (Excel, CSV, PDF)

🔹 Role-Based Access Control

  • Permissions are enforced using field-based security.
  • Users without access receive a “No Data Found” message.

🔹 Table Access Logging

  • Logs all user access attempts for tracking & auditing.

5️⃣ Troubleshooting

IssueSolution
No table data appearsCheck permission settings
Debug output missingEnsure user is in group_id 0=dev or admin
API returns empty JSONConfirm tablearray is populated

6️⃣ Future Enhancements

✅ Expand API Capabilities – Add support for filters & pagination
✅ Custom Export Options – Additional format conversions
✅ Enhanced UI – Consider integrating charts or summary statistics

7️⃣ Summary

The Splash View dynamically renders tables from various data sources while enforcing permissions and logging activity.

💡 Key Takeaways

✔️ Supports multiple file types
✔️ Implements role-based access control
✔️ Provides logging & auditing
✔️ Allows interactive table search & filtering
✔️ Can return JSON API responses
✔️ Accepts two different URL formats
✔️ Available in myBMT via the shower icon on the 🛁Table Catalogue listings and 👓Azure Explore Pages

Leave a Comment