Integration Dashboard Pages

Add optional pages to the PraisonAI bot integration dashboard

Integration dashboard pages let a bot install extra views — like a live workflow-runs table or a health panel — into the PraisonAI integration dashboard.

Quick Start

1. See the pages that ship

   Launch the integration dashboard and open the 🔄 Workflow Runs and 🤖 Bot Health tabs.

   praisonai serve ui-gateway --style dashboard --port 8765

2. Add your own page

   Drop a decorated async function in praisonai_bot/integration/pages/ and register it.

   # praisonai_bot/integration/pages/my_status.py
   import praisonaiui as aiui
   
   
   @aiui.page("my-status", title="My Status", icon="✨")
   async def my_status_page():
       """Dashboard tab showing custom status data."""
       try:
           from myapp.services import get_status
       except ImportError:
           return {"items": [], "note": "Status service unavailable"}
   
       return {"items": await get_status(), "status": "ready"}

How It Works

The host app imports praisonai_bot.integration.pages at configure time, each @aiui.page-decorated function registers itself, and the dashboard renders each function’s returned dict as a page.

The mount point is host_app.py:193, where the pages are imported inside a try/except ImportError: pass guard so a missing dependency never breaks the host app.

Pages That Ship Today

Two pages ship with praisonai-bot.

The workflow-runs page returns one of two shapes depending on whether the workflows bridge is available.

# Bridge unavailable — service not installed / not initialised
{"runs": [], "note": "Workflow bridge unavailable"}

# Bridge ready — dashboard renders the runs table
{"runs": [], "service": "WorkflowRunService", "status": "ready"}

The bot-health page returns a live gateway status.

# Gateway not running
{"gateway": "unknown", "channels": []}

# Gateway running
{"gateway": "running", "channels": [], "agents": [...]}

Writing Your Own Page

A page is an async function decorated with @aiui.page(...) that returns a JSON-serialisable dict.

# praisonai_bot/integration/pages/my_status.py
import praisonaiui as aiui


@aiui.page("my-status", title="My Status", icon="✨")
async def my_status_page():
    """Dashboard tab showing custom status data."""
    try:
        from myapp.services import get_status
    except ImportError:
        return {"items": [], "note": "Status service unavailable"}

    return {"items": await get_status(), "status": "ready"}

Register it with one import line so the host app discovers it.

# praisonai_bot/integration/pages/__init__.py
from . import bot_health, workflow_runs, my_status  # noqa: F401

Restart the dashboard; the ✨ My Status tab appears in the sidebar.

Backward Compatibility

Best Practices

Related