Dashboard Controls - WebTMA 5

Dashboard controls, i.e., graphs, display query data. These are queries you create using custom queries on the Browse Tab of various windows in WebTMA such as the Work Order window. The application polls the database to update the controls regularly.

When you create controls from MyPage, you can:

• Arrange controls in any order on the Tab
• Resize controls as desired
• Remove controls from view without deleting the control

If various statistics are useful at certain times of the month or year, create the controls and show or hide them as needed.

You may prefer to have a separate Dashboard Tab on MyPage. This gives more room to arrange the controls. However, you can add Dashboard controls to any MyPage Tab.

Initially, new controls display at the upper left of the Tab. If another control also occupies that space, a new control covers it. Drag-and-drop new controls to arrange them on the Tab.

Resize controls using the standard MS Windows resizing arrows at the corners or centers of the control frame.

How to Edit Dashboard Controls

1. Click the Tab where your Dashboard control is saved.
2. Click Edit on the WebTMA toolbar.
3. Click the Open Edit Window  icon on the Control title bar.
4. Make changes to the fields.
5. Click the pencil icon to make changes to data lines.
6. Click Save on the popup window.
7. Click Save on the WebTMA toolbar.

Data Sources for Controls

WebTMA offers three types of data sources to include in Dashboard Controls:

• Browse
• Non-system Reports
• Custom SQL

The Browse data comes from custom queries created from the Browse Tab of the different modules.

The Report data comes from the Report Writer. These can be standard reports copied from the Report Manager; however, it is rare that a standard report generates a limited data range that is meaningful.

A targeted approach would be to create a report applicable to one technician for Open Work Orders and another report for Closed Work Orders. Once created, these reports can provide a valuable graphic report when used with the Report Query Type.

WebTMA includes a number of Custom SQL queries for your use. Client-hosted users can also write their own SQL Query for Dashboard. See Help > Help Page > System Administrator Setup for more information about the Custom SQL window.

How to Set Up Bar Charts

WebTMA recommends you have a separate Dashboard Tab.

The following steps elaborate on the choices you have for creating bar charts.

1. Complete steps 1-5 in How to Add New MyPage Controls.
2. Click the Add New Data Item link.
3. Complete the Data Item Entry window. The Label field identifies the bar on the chart. Typically you won't need a Legend since the labels do the job.
4. Select the Query Type. Usually this is Browse.
5. Select the Window (i.e., module) related to the content of the bar chart. This field is not applicable if you select a Report Query Type.
6. Select a Query created for the module. Note: Queries are created from the Browse Tab of the module. If you use the Report Query Type, only reports are included in the selection list.
7. Select the Color for the bar.
8. Click the Update button on the Data Entry popup window.

Add More Data Segments

1. Repeat steps 2-6 to add more data segments. These can be from the same or different windows.
2. Click Save on the MyPage Object Properties window. **
3. Click Save on the WebTMA toolbar.

** Initially, new controls display at the upper left of the Tab. If you have not moved an existing control, the new control covers it. In Edit mode, drag-and-drop new controls to arrange them on the Tab. Resize the Controls with click-and-drag using the standard MS Windows resizing arrows

How to Set Up Pie Charts

WebTMA recommends you have a separate Dashboard Tab.

The following steps elaborate on the choices you have for creating pie charts. Important: The Pie chart only displays segments that have data.

1. Complete steps 1-5 in How to Add New MyPage Controls.
2. Click the Add New Data Item link.
3. Complete the Data Item Entry window. The Label field identifies the pie slice on the chart. Note: Use short label names to prevent overwriting on the graphic display.
4. Select the Query Type. Usually this is Browse.
5. Select the Window (i.e., module) related to the content of the pie chart. This field is not applicable if you select Report in the Query Type field.
6. Select a Query created for the module. Note: Queries are created from the Browse Tab of the module. If you use the Report Query Type, only reports are included in the selection list.
7. Select the Color for the pie slice.
8. Click the Update button on the Data Entry popup window.

Add More Data Segments

1. Repeat steps 2-6 to add more data segments. These can be from the same or different windows.
2. Click Save on the MyPage Object Properties window. **
3. Click Save on the WebTMA toolbar.

** Initially, new controls display at the upper left of the Tab. If you have not moved an existing control, the new control covers it. In Edit mode, drag-and-drop new controls to arrange them on the Tab. Resize the Controls with click-and-drag using the standard MS Windows resizing arrows.

How to Set Up Dial Gauge

The Dial Gauge display is similar in appearance to an automobile speedometer (mechanical type).

The chart has more settings than others because you have a number of additional features such as thresholds to alert users when certain limits are passed.

The following steps elaborate on the choices you have for creating dial gauges.

1. Complete steps 1-5 in How to Add New MyPage Controls.
2. Complete the Query Type, Window, and Query fields.
3. Select the Dial Color and Needle Color field values.
4. Set the Start and End Value range.
5. Establish the Major Tick Increment and Minor Tick Increment for visual identifiers on the dial.
6. Go to the topics How to Set Dial Segments and How to Set Dial Thresholds for instructions on how to set visual ranges within the dial to differentiate between "safe" numbers and "unacceptable" numbers.

How to Set Up Digital Gauge

The Digital Gauge is a numeric display of data you want to track. The Digital Gauge is more efficient and loads the fastest because its load on the system is lower.

The settings for this chart are similar to the Dial Gauge with more settings than others because it offers a number of additional features such as thresholds to alert users when certain limits are passed.

The following steps elaborate on the choices you have for creating digital gauges.

1. Complete steps 1-5 in How to Add New MyPage Controls.
2. Complete the Query Type, Window, and Query fields.
3. Select the Dial Color.
4. (Optional) go to the Segment and Threshold topics mentioned below if you desire to use these features.
5. Scroll down to click the Save button on the window to save your Digital Gauge.
6. Click Save on the WebTMA toolbar.

How to Set Dial or Digital Segments

Segments are used to define acceptable and unacceptable values for Dial and Digital Gauges.

Use the Add New Segment link to determine the start and end values of the segments as well as the color. For example, if you have a blue background for the dial, you can create a segment in red for visual contrast.

1. Click the Add New Segment link.
2. Enter the starting segment value in the Start field.
3. Enter the ending segment value in the End field.
4. Select a color for the segment. Be sure to make it different from the background color.
5. Click the Update link below the color field.
6. Repeat steps 2-6 to add more segments.
7. (Optional) Set Thresholds using instructions in How to Set Dial Thresholds.
8. Click the Save button on the popup window. You may have to scroll down to locate it.
9. Click Save on the WebTMA toolbar.

Reminder: Initially, new controls display at the upper left of the Tab. If you have not moved an existing control, the new control covers it. In Edit mode, drag-and-drop new controls to arrange them on the Tab. Resize the Controls with click-and-drag using the standard MS Windows resizing arrows.

How to Set Dial or Digital Thresholds

Set thresholds in situations where management needs to know when data exceeds important limits. If a control passes the threshold value, the border surrounding the control flashes in View mode and the system sends an alert message. If you set a Dial threshold or background color and later change the control to Digital, it will use the same colors. Be aware that green works well; however yellow or red do not.

Note that Thresholds cannot be set on Digital Gauge controls when they are based on Custom SQL queries.

After making the initial Dial or Digital Gauge selections, use these instructions to add threshold values.

1. Click the Add New Threshold link.
2. Enter the limit number in the Value field.
3. Enter the E-mail addresses of concerned managers. To enter several addresses, separate each with a semi-colon (;).
4. Type the alert Message. It can extend beyond the size of the field.
5. Click the Update link below the message field.
6. Click the Save button on the popup window. You may have to scroll down to locate it.
7. Click Save on the WebTMA toolbar.

How to Show/Hide a Dashboard Control

1. Click the Tab displaying the desired control.
2. Click Edit on the WebTMA toolbar.
3. Click the Manage Controls link on the Action Menu.
4. Mark or clear the check box for the control.
5. Click the Update button.
6. Click Save on the WebTMA toolbar.

NOTE:  A quick way to hide a control is to click the  Close Item icon on the Control title bar and click Save on the WebTMA toolbar.

How to Add Reports to Controls

Every MyPage Control has an option to add non-system reports. If you view a report on a regular basis, adding the report to the Control is convenient. You may need to scroll to the bottom of the MyPage Add Object window to see the Add Reports link. If you want to use a standard report, copy it to the Report Writer where it will be available for selection from the control.

With the Control in Add or Edit mode:

1. Click the Add Reports link in the Reports grid.
2. Click the check box of all reports you want to add to this Control.
3. Click Save on the Add Linked Report popup.
4. Click Save on the MyPage Add Object popup.
5. Click Save on the WebTMA toolbar.

In View mode, an Open linked report  icon displays on the right side of the Control title bar. If you add a single report to the Control, WebTMA generates the report automatically when you click the icon. If you have selected several reports, click the icon to select from a list of your reports.

This option is different from the Report List Control. For Report List, the report names you select make up the body of the Control and display as list of hyperlinks. When the Query Type is Report, WebTMA filters the list and does not show Private reports unless the logged-in user is the Owner, i.e., the person who created the report and marked it private.

NOTE:  The value displayed for a Report query on a chart or gauge control is the row count based on the criteria of the selected report. Using a report in this way allows the reuse of a complex query in an existing report without having to recreate it in the query builder on the Browse Tab.