Dashboard framework

From UG

(Difference between revisions)

Jump to: navigation, search

Revision as of 14:55, 21 March 2012

Info

parent: 0003127: (Dashboard) ......

Business Requirements

Need special page with various panels such as Weather, News, etc
Need separate area on Dashboard for Dashboard Reports (DRs)
above should be available on both Client and Internal Apps
need flexible admin to manage above on the system, manager, user levels
persistence (system must remember last state of dashboard for individual user to reproduce at the next login)

Glossary

Dashboard - it is a space between Header/Main Menu and Footer on a CT2 Home Page. It contains various Panels ("Widgets") with valuable information such as "Weather", "RSS News feeds" or "Truck Dom Stats Dashboard Report".

One important type of Dashboard widget is Dashboard Report (DR). Sometime we call them KPI. For more info see DR framework wiki.

Fig below explains layout.

Solution version 1

This is a current version !

Since we have 2 apps currently (Client and Internal) implementation for each slightly differs.

Dashboard for Internal App

Example:

Example of related config:

Dashboard for Client App

Client example (Main Dashboard):

KPIs Dashboard (additional dashboard):

Related config (superuser level):

Related config (user level):

SOW 2

Mantis: 3067: [* DR/KPI] (Dashboard) Create Dashboard framework

Core requirements

In this version we attempt to set standards for how/where to configure dashboard panels.
It also suggests another approach to adding additional dashboards to the system.

Approved by Marc --Alex 14:33, 4 October 2011 (EDT)

Solution

Summary

Look and feel

Dashboard framework provides displaying of specific widgets on Dashboard area (Dashboard) of CT2 Home Page only.
- Dashboard area contains specific dashboard tabs (#Multiple dashboards) with sets of dashboard panels.
  - Each dashboard panel reflects specific widget with valuable information.

Configuration

Each CT2 user should have ability to:
- Add any number of additional tabs onto Dashboard and name them arbitrary.
- Assign any available panel to any specific dashboard tab.
  - One report can be assigned to one tab only (need to clarify!!!).
List of available panels for each user (role?) defines by settings:
- CT2 Admin level. Available reports: those which were activated for certain User on Admin level of settings.
- User - those which were selected to display on Dashboard from list of available reports by User himself.
- Assigned reports - those which assigned to added tab of Dashboard by User for displaying.

Details

Multiple dashboards

tabs should be named by user (default: one tab named "Main")
users should be able to assign panels to specific dashboard tabs (default: all panels on "Main" tab)

Settings (configurations)

Levels of dashboard panel management:

CT2 Admin level settings
- These are settings for each dashboard panel (manage defaults, etc).
- Location: Home > Admin > Dashboard

User settings (Admin level)
- Location: Home > Admin > Users Admin
- This is managed by superuser

User settings (User level) a.k.a. User profile
- Location: Home > User profile
- This is managed by user

CT2 Admin level settings

Similarly to #Company level settings these settings regulate defaults on a highest (system) level. Also there could be some other global settings associated with specific panel/widget/DR.

At this level we could also define what user roles would see what widgets/panels.

Company level settings and Manager level settings were removed by Marc - see history.

= DR for 9 existing Action Required internal reports =

Please display in read only format these settings for user.

Admin level user settings

This could be the same list as the above (in this case it would define defaults or could be used to change settings at the Admin level at some point). Or they could include additional settings. Some parameters could be managed at admin level only. In this case they would appear as read only in User settings (User level).

User level User settings

Exceptions

It is possible that it would be hard to fully consolidate all settings for specific widget or DR in one place. For example for Action Required DRs (see DR for 9 existing Action Required internal reports) certain parameters are defined at the Reports Scheduler level.

Persistence

System must remember last state (location, state [open/closed], settings) of Dashboard for individual user to reproduce it at the next login.

Client Visibility Rules

- Client Visibility Rules affect displaying of DR results in Client Application.

History

0003067: [* DR/KPI] (Dashboard) Create Dashboard framework

@@ Line 69: / Line 69: @@
 === Solution ===
-* Dashboard framework provides displaying of Dashboard Reports (DR) on a CT2 Home Page as specified.
+==== Summary ====
-* Dashboard area contains ...
-* Dashboard panels should be presented in one place in System. This is home page of CT2 (internal or client).
+'''Look and feel'''
-** ''Client Visibility Rules'' affect displaying of DR results in Client Application.
-* It is suggested to use multiple dashboards based on tabs for DR displaying:
+* Dashboard framework provides displaying of specific widgets on '''Dashboard area''' (Dashboard) of CT2 Home Page only.
-** Each CT2 user should have ability to combine panels and assign them to tabs on Dashboard.
+** Dashboard area contains specific '''dashboard tabs''' ([[#Multiple dashboards]]) with sets of dashboard panels.
-** One report can be assigned to one tab only.
+*** Each '''dashboard panel''' reflects specific widget with valuable information.
-* Each user has his own set of DR:
-** Available reports - those which were activated for certain User on Admin level of settings.
+'''Configuration'''
-** Customized reports - those which were selected to display on DR desktop from list of available reports by User himself.
+* Each CT2 user should have ability to:
+** Add any number of additional tabs onto Dashboard and name them arbitrary.
+** Assign any available panel to any specific dashboard tab.
+*** One report can be assigned to one tab only ('''need to clarify!!!''').
+* List of available panels for each user (''role?'') defines by settings:
+** ''CT2 Admin level''. Available reports: those which were activated for certain User on Admin level of settings.
+** User - those which were selected to display on Dashboard from list of available reports by User himself.
 ** Assigned reports - those which assigned to added tab of Dashboard by User for displaying.
-==== Multiple dashboards ====
+==== Details ====
+===== Multiple dashboards =====
 [[File:Multiple dashbords based on tabs.JPG]]
@@ Line 88: / Line 97: @@
 * users should be able to assign panels to specific dashboard tabs (default: all panels on "Main" tab)
-==== Settings (configurations) ====
+===== Settings (configurations) =====
 Levels of dashboard panel management:
@@ Line 104: / Line 113: @@
 ** This is managed by user
-===== User level User settings =====
-[[File:Client User profile Dash Tab v2.JPG]]
+====== CT2 Admin level settings ======
-====== DR for 9 existing Action Required internal reports ======
+Similarly to [[#Company level settings]] these settings regulate defaults on a highest (system) level. Also there could be some other global settings associated with specific panel/widget/DR.
-Please display in read only format these settings for user.
-===== Admin level user settings =====
+At this level we could also define what user roles would see what widgets/panels.
-This could be the same list as the above (in this case it would define defaults or could be used to change settings at the Admin level at some point). Or they could include additional settings. Some parameters could be managed at admin level only. In this case they would appear as read only in ''User settings (User level)''.
+ Company level settings and Manager level settings were removed by Marc - see history.
-===== Company level settings =====
+======= DR for 9 existing Action Required internal reports =======
+Please display in read only format these settings for user.
-Removed by Marc - see history.
+====== Admin level user settings ======
-===== Manager level settings =====
+This could be the same list as the above (in this case it would define defaults or could be used to change settings at the Admin level at some point). Or they could include additional settings. Some parameters could be managed at admin level only. In this case they would appear as read only in ''User settings (User level)''.
-Removed by Marc - see history.
+====== User level User settings ======
-===== CT2 Admin level settings =====
+[[File:Client User profile Dash Tab v2.JPG]]
-Similarly to [[#Company level settings]] these settings regulate defaults on a highest (system) level. Also there could be some other global settings associated with specific panel/widget/DR.
+====== Exceptions ======
-At this level we could also define what user roles would see what widgets/panels.
-===== Exceptions =====
 It is possible that it would be hard to fully consolidate all settings for specific widget or DR in one place. For example for Action Required DRs (see [[DR for 9 existing Action Required internal reports]]) certain parameters are defined at the ''Reports Scheduler'' level.
@@ Line 135: / Line 139: @@
 See also: [[#DR for 9 existing Action Required internal reports]]
-==== Persistence ====
+===== Persistence =====
 System must remember last state (location, state [open/closed], settings) of Dashboard for individual user to reproduce it  at the next login.
+===== Client Visibility Rules =====
+** ''Client Visibility Rules'' affect displaying of DR results in Client Application.
 == History ==
 === 	0003067: [* DR/KPI] (Dashboard) Create Dashboard framework  ===