diff --git a/plugin_use_cases/.env.example b/plugin_use_cases/.env.example deleted file mode 100644 index 6c32cde0..00000000 --- a/plugin_use_cases/.env.example +++ /dev/null @@ -1,71 +0,0 @@ -# ============================================================================= -# SIGMA PLUGIN HOST APPLICATION CONFIGURATION -# ============================================================================= -# This file contains all configuration for the Sigma Plugin Host Application -# Copy this file to .env and update the values below to match your Sigma instance -# ============================================================================= - -# ============================================================================= -# SIGMA API CONFIGURATION -# ============================================================================= -# Your Sigma API credentials - obtain from Sigma Administration > Developer Access -SIGMA_CLIENT_ID=your-client-id-here -SIGMA_CLIENT_SECRET=your-client-secret-here -SIGMA_API_BASE_URL=https://aws-api.sigmacomputing.com - -# ============================================================================= -# APPLICATION SETTINGS -# ============================================================================= -# Port for the Express server (default: 3000) -PORT=3000 - -# Enable debug logging (true/false) -DEBUG=false - -# ============================================================================= -# USER CONFIGURATION -# ============================================================================= -# Email addresses for different user types in your Sigma organization -BUILD_EMAIL=build.user@example.com -VIEW_EMAIL=view.user@example.com -ADMIN_EMAIL=admin.user@example.com - -# Account types for different users -BUILD_ACCOUNT_TYPE=Build -VIEW_ACCOUNT_TYPE=View - -# ============================================================================= -# WORKBOOK CONFIGURATION -# ============================================================================= -# Your Sigma organization slug (found in your Sigma URL) -ORG_SLUG=your-org-slug - -# The name of your workbook containing the dashboard elements -WORKBOOK_NAME=Your-Workbook-Name - -# Base URL for embed links (usually your Sigma domain) -EMBED_URL_BASE=https://app.sigmacomputing.com - -# ============================================================================= -# PLUGIN CONFIGURATION -# ============================================================================= -# Name of your plugin for display purposes -PLUGIN_NAME=Dashboard Builder - -# Plugin-specific embed parameters (true/false values) -PLUGIN_MODE=true -DISABLE_AUTO_REFRESH=false -DISABLE_MOBILE_VIEW=false -HIDE_FOLDER_NAVIGATION=false -HIDE_MENU=false -HIDE_PAGE_CONTROLS=false -HIDE_RELOAD_BUTTON=false -HIDE_TITLE=false -HIDE_TOOLTIP=false -HIDE_VIEW_SELECT=false - -# Language and display settings -LNG=en -MENU_POSITION=top -RESPONSIVE_HEIGHT=true -THEME=light \ No newline at end of file diff --git a/plugin_use_cases/README.md b/plugin_use_cases/README.md index 4e2918d1..9624a2c6 100644 --- a/plugin_use_cases/README.md +++ b/plugin_use_cases/README.md @@ -1,17 +1,17 @@ -# 🚀 Sigma Dashboard Builder - Multi-Area KPI Placement System +# Sigma Dashboard Builder - Multi-Area KPI Placement System A sophisticated host application for Sigma's Dashboard Builder plugin that enables users to place different KPIs across three independent dashboard areas with persistent bookmark management. -## ✨ Key Features +## Key Features -- **🎯 Multi-Area KPI Placement**: Place different KPIs in 3 independent dashboard areas -- **💾 Persistent Bookmarks**: Save and restore complete multi-area configurations -- **🔄 Incremental Building**: Add KPIs to existing bookmarks without losing current state -- **🛡️ Cross-Contamination Prevention**: Each area operates independently -- **⚡ Real-time Synchronization**: ExploreKey sync across all areas -- **🔐 Secure Authentication**: JWT-based authentication with automatic token refresh +- **Multi-Area KPI Placement**: Place different KPIs in 3 independent dashboard areas +- **Persistent Bookmarks**: Save and restore complete multi-area configurations +- **Incremental Building**: Add KPIs to existing bookmarks without losing current state +- **Cross-Contamination Prevention**: Each area operates independently +- **Real-time Synchronization**: ExploreKey sync across all areas +- **Secure Authentication**: JWT-based authentication with automatic token refresh -## 🏗️ Architecture +## Architecture ### Dual Storage System - **Sigma Bookmarks**: Store exploreKey and workbook state (single-state, cloud)