Type of document: Usebility Checklist

Transcription

1 Project: JEGraph Type of document: Usebility Checklist Author: Version: 1.90

2 Type of Documet Developer guidelines User guidelines Dutybook Specification Programming and testing Test specification Key Data Levell 1 Responsible domain Editor(s) Level 2 MxB Originator(s) Document version 1.70 Date of issue (built) Brief description Objectives Start date Finish date Priority [1..5] Document History / Modifications version date author description of modification of the document Broder Fredrich Broder Fredrich New step of the JEBench added Page 2 / 9

3 Table of Contents 0 Revision JEGraph Login Dialog Analysis Loading Analysis Saving Analysis General Savings JEChart Tree Dialog Cartesian Plugins Zooming Settings Dialog Colours Data Row Order Info Headline for JEChart Info Headline for JEDigital Info Headline for JETable Info Headline for JEGIS Info Headline for JEBench JEChart Additional Settings Threshold Plug-in Size and Movement Revision Tested with Operating System: Installed Java Version: Test Date Page 3 / 9

4 1 JEGraph This section covers all steps of the general workflow. 1.1 Login Dialog The login dialog is placed in the center of the display. When there are more than one displays, it is placed in the center of one of them, not in their collective. The user can enter username, password and server URL for logging in. The language box has always selected one language as default. When changing the selected entry in the language box, all text is changed to the newly selected language. When a wrong username password combination has been entered, the user gets informed that the login has not been successful. When the program performs actions, the dialog is grayed out and tells the user to wait. 1.2 Analysis It is possible to save the state of the JEGraph with all the opened plugins. When the user starts the program the next time, it is easier to get the desired state by loading the old state Loading Analysis After the user has logged in, the main window opens and shortly after this, the analysis load dialog opens. He/She can see a list of available analysis. Below the list, there is a box with options about how the selected analysis shall be loaded. When the user clicks on a list entry, the program loads the saved datarows for checking the available timespans. With this information, the date fields in the time box are adjusted to the highest date, which all of the data rows have in common. By default, last month is selected. When a list entry is clicked and the date fields are adjusted, the duration of the date fields is as the selected checkbox forces it. When the user clicks Ok, the analysis is being loaded. The same happens when an entry is being double clicked. When the user clicks Cancel while loading, the loading is interrupted and already loaded plugins are closed. The datarows of loaded plugins are loaded with the given timespan or a shorter timespan if no data is available earlier. When an analysis contains a plugin with a data row that does not exist anymore, a notification is shown and everything is loaded as normal, as if the now deleted data row hadn't exist. Page 4 / 9

5 When an analysis contains a plugin with one data row which does not exist anymore, the plugin is not opened, since it would be empty Saving Analysis When the user clicks on File Save analysis, the program asks to overwrite the opened analysis, which is referred to by name. When the user loads another analysis and then clicks on File Save analysis, the name of the last loaded analysis is shown. If no analysis has been loaded yet, the tree is opened. The tree is also opened when the user clicks on file Save analyis as. In the opened tree the user can navigate to a folder and click on ok. He/She is then asked to enter the desired name for that analysis. When the user select a node with an analysis and clicks ok or double clicks the analysis node, it is asked whether the saved analysis should be overwritten. The user can save analyses. This is not dependent on the version of the program as well as the version of the saved plugins General Savings When the user saves an analysis the following aspects are saved: The ID of a plugin The order of the plugins. The position and size of the plugins. The linking state of plugins JEChart An opened analysis has the same following attributes as the saved one: Colours Fill mode ( filled / not filled) Transparency Bars / Areas Stacked / not stacked 100% mode Number of decimal places Line thickness The chosen unit 1.3 Tree Dialog When the user wants to load data rows, he/she is always confronted with the tree dialog with Page 5 / 9

6 saved nodes and data rows. The user can open nodes via double clicking on them. The user can open and close nodes via clicking the small arrow. Every node has a small symbol. Data row nodes have a select box. When a data row contains data, the min date and max date contain the corresponding values. When the user selects a node, in the date field are two dates set. The end date is set to the latest date, the start date is set back in an interval related to the selected check box. When the user selects more than one node, the date fields contain the intersection time set of the rows. The end node is determined by the highest date, at which all nodes contain data. When the user selects more than one node and the nodes do not have time sets in common, the date fields contain the latest available time of one data row. It is not possible to select nodes and set dates where any data row contains no data. When the user selects a data row, the list with aggregates (raw data, clean data, month data, ) gets enabled. The aggregates list only contains entries where all selected nodes contain data. When the user clicks the ok button, the selected data rows are loaded in the specified time set and with the specified aggregation. When the data rows have been loaded and the dialog is closed, the user can open the dialog again via clicking on the tree dialog button on the left hand side of the plugin. The dialog now looks the same as it looked when the plugin was loaded. When the user click on the tree dialog button in the top bar, the dialog looks the same as the last time it has been used. 2 Cartesian Plugins Cartesian plugins are plugins which contain a x and y coordinate with a time line on the x axis and a value axis on the y axis. 2.1 Zooming The user can zoom into the data. He clicks on the chart, moves the mouse to the left or right and releases the mouse. It is now zoomed into the selected area unless there is no data point. When having zoomed the user can move the shown area via right clicking on the chart and moving the mouse. The user can undo and redo zoom steps with the corresponding buttons. He can also undo all zoom actions at once. The user can add a local zoom handler into the chart. This zoom handler creates a section where the user can see detailed data. He can move the section via right-clicking on it and moving the mouse. The section can be widened via clicking on the Page 6 / 9

7 corresponding button. The user can link Cartesian plugins when they are in no zooming state. When now zooming actions are performed, they involve all linked plugins. When the plugins are in a zoomed state and the user move the time period via rightclicking and moving the mouse, all plugins move. 2.2 Settings Dialog The settings dialogue contains options for the user like changing the colour or the order of data rows. It can be opened via clicking on the toolbar-button. When the user performs changes in the dialog, it is applied immediately to the plugin. When clicking on ok, the dialogue closes and the user can work with the applied changes. When clicking on cancel, the dialog closes and the plugin shows all changes reverted to the state before settings dialogue was opened Colours When the users select a data row via clicking on it and then clicks on the colour button, a colour choosing menu is opened where the user can choose a new colour for the selected data row. When clicking on ok, the chosen colour is taken and the colour is used for the data row list. The colour in the plugin is updated when the user closes the settings dialogue via clicking on the ok button Data Row Order The settings dialogue contains a list of the selected data rows. The User can click on a data row and then on the arrows to change the order. The higher a data row is, the more it is in the back. If it is at the top, it is more likely that is is overdrawn by other data rows. 3 JEChart The JEChart shows measuring data on a time line. On the y axis, the user can the values the data. 3.1 Info Headline Page 7 / 9

8 The info headline is shown above the chart. It contains information about all shown data rows. The first column contains a small symbol with the chosen colour of the data row. The third column contains the name of the loaded data. If more than one data rows are chosen, it is shown in brackets where the data row is saved. E.g. if the user selects energy data in different cities, the bracket contains the name of the city. Columns 3 to 5 contain maximum, minimum and average value of the selected data. Column 5 shows the value of the data point where the mouse cursor is. If the plugins are linked, the value is also updated in every linked plugin. Column 6 shows the date of the cursor data point. 3.2 Additional Settings In the settings dialog the user can perform more changes to the chart than in other Cartesian plugins. The user can change between filled and non filled graphs. Non filled graphs only show a line of the data and do not fill the are below the line. With this option, the user can see graphs, which otherwise could be overdrawn. When haven chosen filled graphs, the user can decide if he wants the coloured area to be transparent. With this option, the user can see graphs, which otherwise would be hidden. The user can choose between two chart types: bar and area diagram. The user can choose between cumulative and non-cumulative diagrams. When having chosen cumulative diagram the y axis should be updated. Additionally, the user can choose a 100% mode. In this mode, the chart shows the share of the share of each data row of the cumulative data. The user can specify the values he wants to see. E.g., the the values of loaded data rows lie between 90 and 100 but the range between 0 and 100 is shown, he can set the range to 90 and 100. He can also change the number of decimal places and the unit the data is shown in. 3.3 Threshold The threshold can be activated via clicking on the button with the two arrows. The threshold can not be activated when more than one data row has been loaded. The threshold is created with two lines, one at the top and one at the button. Left to the chart a slider is created. This slider contains two buttons which can be moved with a left mouse click and then moving the mouse up and down. Data points below the bottom line are shown in green, data points between the two lines are yellow, the data points above the upper line are red. Next to the buttons there is a small text field which contains a number that shows the value of the current line. The upper text field has a red background, the bottom text field has a green background. When the buttons are moved, the lines on the chart and the text field also move. The colour of the data points changes when the lines cross a data point. Page 8 / 9

9 4 Plug-in Size and Movement Every plugin has on the right and bottom and a grey bar. With this bar, the plugin can be resized. Plugins cannot be wider than the width of the window. That means, there is never an horizontal scroll bar shown. A vertical scroll bar is only shown when the size the plugins need is bigger than the windows the plugins are in. When a plugin is created, it gets as much space as it needs. Therefore, when there is no other plugin, the plugin gets the whole space. If a plugin has a maximum size, it does not get the whole space. When a plugin is created and all the space is taken, the old plugins are resized and moved up, so the new plugin fits into the window. If there is not enough space for every plugin, no plugin is resized. The new plugin is places at the bottom and the window gets a vertical scroll bar. Every plugin contains a grey headline with its name and number. When left clicking on the headline and moving the mouse, the plugin is moved. The plugin cannot leave the window. When the plugin gets near the border of another plugin or near the border of the window, it is moved directly to the border, as if it sticks to the border. The described sticking is activated when the distance between the border is smaller than 30px. When two plugins overlap and the space is more than 60% overlapped, the two plugins change the position. This is only done, when after the position change there is no overlapping. When a plugin is moved and the user releases the mouse, the plugin jumps back to its original place. The plugin jumps to another place where it was moved before, when the plugin has a horizontal and a vertical anchor point. That means, a plugin cannot be placed e.g. in the middle of the window, when there is no other plugin next to it. Tested by: Signed by: Page 9 / 9