|
Next revision
|
Previous revision
|
versago:dashboard_configuration [2019/01/14 11:48]
runger created |
versago:dashboard_configuration [2020/06/26 14:56] (current)
runger General rework; remove Custom Page and Gauge references |
| ====== Introduction ====== | ====== Introduction (Dashboards) ====== |
| |
| Versago **Dashboards** provide a way to display information from multiple Versago sources in a single web page. Grids (standard report output) and charts can be displayed. There are also options for a “gauge” presentation and for custom HTML. | Versago **Dashboards** provide a way to display information from multiple Versago sources in a single web page. Grids (standard report output) and charts can be displayed. There are also options for a “gauge” presentation and for custom HTML. |
| ====== Related Documents ====== | ====== Related Documents ====== |
| |
| * Versago Reports – Configuration Guide | * [[versago:report_configuration|Reports Configuration]] |
| * Versago Reports - Charts | * [[versago:chart_configuration|Charts Configuration]] |
| |
| ====== Before You Begin ====== | ====== Before You Begin ====== |
| The example below illustrates how a dashboard might be configured. | The example below illustrates how a dashboard might be configured. |
| |
| {{:versago/dashboards1.png?576x334}} | {{ :versago/dashboards1.png?576x334 }} |
| |
| ====== To Begin ====== | ====== To Begin ====== |
| * Click on the “Dashboards” link in the Admin console to begin. | * Click on the “Dashboards” link in the Admin console to begin. |
| |
| {{:versago/dashboards2.png?576x61}} | {{ :versago/dashboards2.png?576x61 }} |
| |
| The Dashboard maintenance function consists of three elements, each on a separate tab. | The Dashboard maintenance function consists of three elements, each on a separate tab. |
| |
| - A listing of existing dashboards. This view is displayed when the function is opened. | * A listing of existing dashboards. This view is displayed when the function is opened. |
| - Click the [**Add New Dashboard**] button to create a new report. | * Click the [**Add New Dashboard**] button to create a new report. |
| - Click the link in the Dashboard Name column to edit an existing report. | * Click the link in the Dashboard Name column to edit an existing report. |
| - Click the red **X** on a row to remove the dashboard. | * Click the red **X** on a row to remove the dashboard. |
| - The remaining elements (tabs) can are accessed in sequence to create a new dashboard, or directly when maintaining an existing dashboard. The use of each element is described in the following sections. | * The remaining elements (tabs) can are accessed in sequence to create a new dashboard, or directly when maintaining an existing dashboard. The use of each element is described in the following sections. |
| |
| ====== Creating New Dashboard ====== | ====== Creating New Dashboard ====== |
| As with all other Versago functions, Roles control access to dashboards. When creating a new dashboard, the Roles selection is the first stop of adding a new dashboard. | As with all other Versago functions, Roles control access to dashboards. When creating a new dashboard, the Roles selection is the first stop of adding a new dashboard. |
| |
| {{:versago/dashboards3.png?384x142}} | {{ :versago/dashboards3.png?384x142 }} |
| |
| - At least one role must be selected for the dashboard to be saved. | * At least one role must be selected for the dashboard to be saved. |
| - Roles can be changed at any time. | * Roles can be changed at any time. |
| - Click the “Dashboard Editor” tab to continue. | * Click the “Dashboard Editor” tab to continue. |
| |
| ===== Assign Name and Initial Frame ===== | ===== Assign Name and Initial Frame ===== |
| A basic dashboard must have a name and at least one frame to be added. The following steps will allow you to add a basic dashboard for additional configuration. | A basic dashboard must have a name and at least one frame to be added. The following steps will allow you to add a basic dashboard for additional configuration. |
| |
| {{:versago/dashboards4.png?384x78}} | {{ :versago/dashboards4.png?384x78 }} |
| |
| - Enter a **Name** for the dashboard. | * Enter a **Name** for the dashboard. |
| - This name is displayed in the menu structure and can be changed at any time. | * This name is displayed in the menu structure and can be changed at any time. |
| - Click [**Add New Frame**]. | * Click [**Add New Frame**]. |
| - Information about managing frames is found in the next section of this document. | * Information about managing frames is found in the next section of this document. |
| - [**Save**] and [**Finish**] can only be used after adding the first frame as described below. [**Cancel**] can be used at any time. | * [**Save**] and [**Finish**] can only be used after adding the first frame as described below. [**Cancel**] can be used at any time. |
| - Click [**Save**] to add the new dashboard and continue working. | * Click [**Save**] to add the new dashboard and continue working. |
| - Click [**Finish**] to add the new dashboard and return to the dashboard listing page. | * Click [**Finish**] to add the new dashboard and return to the dashboard listing page. |
| - Click [**Cancel**] to discard any changes and return to the dashboard Roles tab. | * Click [**Cancel**] to discard any changes and return to the dashboard Roles tab. |
| |
| |
| Each frame has its own configuration elements. | Each frame has its own configuration elements. |
| |
| {{:versago/dashboards5.png?576x91}} | {{ :versago/dashboards5.png?576x91 }} |
| |
| - Select an **Object Type** from the drop-down list. | * Select an **Object Type** from the drop-down list. |
| - **Grid** is the standard row/column presentation of a Versago report. | * **Grid** is the standard row/column presentation of a Versago report. |
| - **Calendar** reports do not currently display the calendar layout. This will be addressed in a future update of Versago. | * **Calendar** reports do not currently display the calendar layout. This will be addressed in a future update of Versago. |
| - Reports should typically not use User-Applied Filters. The filters will work, however this somewhat defeats the purpose of the dashboard as a “quick view” presentation. | * Reports should typically not use User-Applied Filters. The filters will work, however this somewhat defeats the purpose of the dashboard as a “quick view” presentation. |
| - **Chart** is a chart presentation from a Versago report. | * **Chart** is a chart presentation from a Versago report. |
| - **Custom Page** provides a way to design a custom “page” that is displayed within the frame. This option is not fully functional and should be used with caution as it may change in a future version of Versago. | |
| - **Gauge** is a dial gauge presentation of data from a Versago report. See [[#appendix-a-gauges|//Appendix A – Gauges//]] for additional information. | <WRAP center round alert 80%> |
| - Select an **Object** from the “Select Object” drop-down. | Two options, **Custom Page** and **Gauge** are displayed as being available for use. <color #ed1c24>These options should not be used at this time</color>. There are known deficiencies in these tools that can prevent them from working as expected. |
| - The selection list will change depending on the Object Type selected in step 1. | </WRAP> |
| - Selecting the Custom Page object type presents an HTML editor area for creating the “page” within the frame. | |
| - Change the **Frame Height** using the arrows in the field. | * Select an **Object** from the “Select Object” drop-down. |
| - A larger number increases the vertical height, a lower number reduces it. | * The selection list will change depending on the Object Type selected in step 1. |
| - The size adjustment only works with the “chart” object type. | * Selecting the Custom Page object type presents an HTML editor area for creating the “page” within the frame. |
| - **Frame manipulation tools** to manage the current frame. \\ {{:versago/dashboards6.png?120x96}} {{:versago/dashboards7.png?127x85}} | * Change the **Frame Height** using the arrows in the field. |
| - **Split Frame** immediately splits a full page-width frame into two half-page frames. | * A larger number increases the vertical height, a lower number reduces it. |
| - **Make full frame** immediately changes a half-page frame into a full page-width frame as a new row in the vertical structure. | * The size adjustment only works with the “chart” object type. |
| - **Move frame** presents a new dialog to indicate where the current frame should be moved. This is a frame-for-frame swap. For example, assume that Frame 2 is half-page and Frame 3 is full-page. If 2 is moved to 3 (or vice versa), the object in 3 becomes half-page and the object in 2 becomes full page. Click [**Submit**] to execute the move. | * **Frame manipulation tools** to manage the current frame. \\ {{ :versago/dashboards6.png?120x96 }} {{ :versago/dashboards7.png?127x85 }} |
| - Use **Delete Frame** to delete the current frame | * **Split Frame** immediately splits a full page-width frame into two half-page frames. |
| - If the current frame is half-page, the remaining frame will automatically become full frame. | * **Make full frame** immediately changes a half-page frame into a full page-width frame as a new row in the vertical structure. |
| | * **Move frame** presents a new dialog to indicate where the current frame should be moved. This is a frame-for-frame swap. For example, assume that Frame 2 is half-page and Frame 3 is full-page. If 2 is moved to 3 (or vice versa), the object in 3 becomes half-page and the object in 2 becomes full page. Click [**Submit**] to execute the move. |
| | * Use **Delete Frame** to delete the current frame |
| | * If the current frame is half-page, the remaining frame will automatically become full frame. |
| |
| |
| Once the initial dashboard has been created, additional frames can be added. Click the [**Add Frame**] button to begin. The “Create Frame” window is presented. | Once the initial dashboard has been created, additional frames can be added. Click the [**Add Frame**] button to begin. The “Create Frame” window is presented. |
| |
| {{:versago/dashboards8.png?576x172}} | {{ :versago/dashboards8.png?576x172 }} |
| |
| - Add a new Full Frame using the “**Full Frame on a new row**” option. Use the “before” and “after” options to place the new frame in the vertical row sequence. | * Add a new Full Frame using the “**Full Frame on a new row**” option. Use the “before” and “after” options to place the new frame in the vertical row sequence. |
| - Add a new half-page frame using the “**Split Frame on existing row**” to convert an existing full-page frame to two half-page frames. | * Add a new half-page frame using the “**Split Frame on existing row**” to convert an existing full-page frame to two half-page frames. |
| - Change an existing split (half-page) frame using the “**Make split Frame to full frame**” option | * Change an existing split (half-page) frame using the “**Make split Frame to full frame**” option |
| - Functions 2 and 3 can also be accomplished using the “Additional controls” on the desired frame as described earlier. | * Functions 2 and 3 can also be accomplished using the “Additional controls” on the desired frame as described earlier. |
| |
| It is highly recommended that a new frame be added as a full frame and configured. Once the configuration is complete the frame can be moved to a split frame as needed. | It is highly recommended that a new frame be added as a full frame and configured. Once the configuration is complete the frame can be moved to a split frame as needed. |
| Frames can be moved around in the dashboard structure using “drag-and-drop.” | Frames can be moved around in the dashboard structure using “drag-and-drop.” |
| |
| - Click and hold down the left mouse button on the frame to be moved. | * Click and hold down the left mouse button on the frame to be moved. |
| - Begin to “drag” (move the cursor while holding down the left mouse button) the frame and the border of the frame will turn **red**. | * Begin to “drag” (move the cursor while holding down the left mouse button) the frame and the border of the frame will turn **red**. |
| - Drag the frame to its new position. The border around the target frame will turn **green** when the new frame is in position. | * Drag the frame to its new position. The border around the target frame will turn **green** when the new frame is in position. |
| - “Drop” the frame by releasing the left mouse button. After a slight delay, the position of the two frames will be swapped. | * “Drop” the frame by releasing the left mouse button. After a slight delay, the position of the two frames will be swapped. |
| | |
| ====== Appendix A – Gauges ====== | |
| | |
| A **gauge** is a special dashboard object that is used to display a current value against a known range of values. A typical example of this might be year-to-date sales against a target range. An example of this is shown below. | |
| | |
| {{:versago/dashboards9.png?480x233}} | |
| | |
| In this case we are looking at YTD profit against an established range of values. The gauge has been structured so that the “best” range is shown at the top of the gauge. | |
| | |
| We have defined three ranges for evaluation. The setup for these ranges is shown below. The gauge needle will reflect the current value of the underlying data any time the gauge is displayed. | |
| | |
| ===== Create a Report ===== | |
| | |
| The information displayed in a gauge comes from a Versago report. This report can be very simple in the detail it reports since it only needs to provide numeric values for the gauge. The report will ideally only have one numeric value. Multiple numeric values tend to cause issues with the reporting in the gauge. | |
| | |
| It is not necessary to calculate a sum of the numeric values in the report. The gauge processing automatically does the summation. | |
| | |
| The report can include parameters, but they should not be displayed to the user. Rather, they can be used to make updates of the data included in the report somewhat easier for the administrator. | |
| | |
| ===== Add a Dashboard Frame for the Gauge ===== | |
| | |
| Add a new frame in the dashboard as described above. The settings are illustrated in the following dashboards. | |
| | |
| {{:versago/dashboards10.png?252x124}} | |
| | |
| The **Select Object** drop-down will list only reports. **Default Value** is automatically determined as the first numeric column in the report. This is why the only numeric value in the report is the one to be used in the gauge. | |
| | |
| ===== Setting the Value Ranges ===== | |
| | |
| The value ranges shown in the gauge are set using the [Set KPI] button on the frame. Following dashboards shows the settings for the sample gauge shown above. | |
| | |
| {{:versago/dashboards11.png?576x157}} | |
| | |
| Each range is always “between” to values. In this example, the lower value is set to zero, but this is not required. The lower and upper boundaries should reflect reasonable value ranges that will be reported. For each range, use the “color picker” tool to select the desired color. See the “Versago – Reports Configuration” document for information on using the color picker tool. | |
| | |
| The ranges will also affect how the gauge pointer is positioned. In the example gauge, the ranges have been set so that the desired range (green) is at the top of the gauge. Some experimentation with the ranges may be needed to arrive at the desired presentation. The ranges and colors can be changed at any time. | |
| | |
| ===== Other Notes ===== | |
| | |
| A given report should only be used for one gauge in a dashboard. Using the same report, especially if the report has two numeric values, tends to lead to some display issues. | |
| | |
| Gauges can be displayed in half-page frames as well as full-page. The following illustration shows two gauges in side-by-side half-page frames. | |
| | |
| {{:versago/dashboards12.png?480x188}} | |
| |
