= !BluePrint: Framework for Dashboards =
[[TOC]]

== Introduction ==

Dashboards (in this BluePrint) are containers to render multiple data resources and/or user activities on a single page, allowing synopsis and cross-analysis of data resources, as well as consolidation of user goals.

== Stakeholders ==
''tbw''

== User Stories ==
''tbw''

== Requirements ==
=== Functional ===

 1. Dashboards support an extensible library of page '''layouts'''
 2. Dashboards support an extensible library of '''widgets''' (=objects to render resources/activities)
 3. Dashboards provide a structure for cross-filtering of widgets (='''common context''')
 4. Dashboards (including widgets) are '''configurable at run time''' (through the web GUI), without requiring any server-side intervention
 5. Dashboard configurations '''can be shared''':
    - with other users
    - with other Sahana instances

=== Non-functional ===
''tbw''
=== Interoperability ===
''tbw''
=== Standards ===
''tbw''
=== System Constraints ===
''tbw''

== Framework Architecture ==

Overview of the tentative framework architecture:

[[Image(dashboard_architecture.png)]]
== Current Implementation ==

- [wiki:S3/S3Dashboard S3Dashboard] (modules/s3/s3dashboard.py)

== Future Extensions ==
''tbw''

== Outstanding Questions ==
''tbw''

== References ==
''tbw''

----
BluePrint