Skip to content

Technical Documentation

Jump to bottom
Dane Dexheimer edited this page Apr 24, 2019 · 38 revisions

Functional Specifications

Group by Variable

This drop-down menu is used to group the data by a selected variable. One group by variable can be selected at a time. The default group variable is set to Form, but the default can be adjusted to any group upon the project team's request. Selecting a group will display the study's query data by that group.

Y-Axis Label Filter

In addition to the group by filter above, a user can also opt to group by form and then subset by field. To use, this functionality, set the Group by filter to Form and click on a form name on the y-axis to view the field data within that form. To reset the chart, users can opt to Group by another variable, refresh the page, or click the Reset chart button.

Group by Status

This drop-down menu is used to group the data by pre-defined status categories. One group by variable can be selected at a time. The default group variable is set to Query Age Category, but the default can be adjusted to any group upon the project team's request. Selecting a group will display the study's query data by that group and adjust the interactive listing to reflect the grouping.

Filter using Legend

In addition to the status group filter, users can filter the data using the associated legend. When a user groups by a status, a legend will appear allowing users to view and interact with the options in that category. Users can interact with the legend by clicking on a colored box or the status description next to it. Upon clicking, the data will filter to show only that status and the status filter above the chart will also reflect this action. To reset the data, click on all of the statuses or the Reset chart button to view all of the data again.

Form Filter

This multi-select multi-select menu is used to filter the data by a selected form. Users can select any forms included in the data and the chart and interactive data listing will update with their selections. The default is set to show all forms in the data set.

Site Filter

This multi-select menu is used to filter the data by site. Users can select multiple sites at a time and the chart and interactive data listing will update with their selections. The default site is set to show all sites in the data set.

Marking Group Filter

This multi-select menu is used to filter the data by marking group, or the group who opened the query. This filter does not show by default, but can be configured to show upon the project team's request. The marking groups included come from the groups represented in the data. Selecting a marking group will display the query data associated with that group.

Visit Filter

This multi-select menu displays a listing of the visits captured in the data set. This filter does not show by default, but can be configured to show upon the project team's request. Users can select any visit included in the data. Selecting a visit will display the query data associated with that visit.

Query Age Filter

The multi-select menu allows the user to choose multiple categories of query ages to view within the chart and the interactive listing. User can select a group by clicking within the filter or select multiple by using CTRL + click to choose more than one option. The user has the ability to click on a selected option again to remove it. The filter defaults to show all age categories.

Status Filter

This menu displays a listing of the statuses in the data set. Users can select one or more at a time to filter the data by that status. The current query statuses captured are Answered, Cancelled, Closed, and Open. The default is to display all query statuses.

Toggle Between Bar Arrangement

This toggle option allows the user to view the query data by a stacked or grouped bar chart. Selecting to view the bar chart in a stacked arrangement presents the number of total queries in a particular group by category. Selecting to view the bar chart in a grouped arrangement presents the group data side-by-side. The chart defaults to display the query data using the stacked bar arrangement.

Show first N groups

This toggle option allows the user to view a selected number of query data groups. Users can opt to show only the first 10, first 25, or all of the groups in the data set. Selecting the option to show the first 10 groups will show data for the 10 groups that have the most data associated with them. Selecting the option to show the first 25 groups will show data for the 25 groups that have the most data associated with them. Selecting the option to show all groups will show every group that is represented in the data. The chart defaults to display the first 10 groups.

Alphabetize

The chart includes the option to alphabetize the query data. This feature can be accessed by clicking the box underneath the Alphabetical? text located above the chart. To return to the pre-sorted view, the user can uncheck the box by clicking in it again. The box is not checked by default, so the data will not be alphabetized when the chart is rendered.

Hover

By moving a mouse cursor over a bar in the chart, users can display metadata for each bar. Hovering the cursor over a particular bar will display the status and number of queries represented in that bar's range. Users can also hover over a form or field label on the y-axis to show the full name of that form or field.

Interactive Bars

The chart contains bars that visually depict the query data. These bars are interactive and can be selected by the user to filter the interactive listing below the chart. The user can select one or more bars at a time and selecting a bar will apply a black fill to the inside of the bar. Any bar selection can be cleared by clicking on the bar(s) again or resetting the chart.

Interactive Listing

An interactive listing is located underneath the chart that contains a detailed table of query records. This interactive table contains the query's data stream, field name, query status, marking group, site, related participant ID, visit/folder, date query was opened, date query was closed, query age, query age category, query text, form description, and field description. The table will update automatically based on what that user inputs for the filters and controls.

Reset Button

The Reset chart button on the top-right of the chart can be pressed at any time to reset the chart to its default settings. Selecting this button will remove all selections and filters within the chart. Resetting the chart will also reset the linked table to show all of the data.

Export Data

Users can download the data as a CSV by clicking on the 'CSV' button located underneath the chart within the detailed view. The CSV file will contain all of the data if no filters have been utilized. If filters have been used, the CSV file will contain the resulting data. The file will also capture any sorting that has been initialized in the data. The CSV download will be named using the following convention: webchartsTableExport, date, and time. This feature can be turned on/off by configuring the chart settings.

Regression Tests

Filters and Controls

  • Confirm that the selectors, filters, chart and data listing all display by default.
  • Confirm filters are grouped together and appear to the left of the chart. Also, confirm other controls are grouped together and appear to the right of the chart
  • Change the input on the Group by filter, confirm that the data groups by the selected variable.
  • Confirm the new Status Group Filter is present and defaulted to Query Age Category.
  • Confirm that you can change the Status Group selection to Query Status and that the chart changes accordingly.
  • Confirm that the Query Age Category, Query Status, Query Recency, Form, Site, Marking Group, and Visit/Folder filters are all present and that all options in each filter are selected by default.
  • Confirm that the filters are all multi-select and you can Ctrl+click selections off and on in each filter and that the chart and table both update accordingly.
  • Confirm that the Query Age Category filter has eight selection options: '0-2 weeks', '2-4 weeks', '4-8 weeks', '8-16 weeks', '> 16 weeks', 'Answered', 'Closed', and 'Cancelled'.
  • Confirm that the Query Recency filter is present, with the correct cutoff filters, even if recency_category_col is set to null and you re-render the chart in CAT.
  • When the data is grouped by Form, change the input on the Form filter, confirm that the chart updates
  • When the data is grouped by form, select the form label and confirm you can view the form: field data for the selected form.
  • Confirm that Status Group has radio buttons and not a drop down menu.
  • Confirm that when Query Age Category is selected in the Status Group, then the chart is labeled Query Age Category and the Query Age Category filters are displayed across the top of the chart. Selected Query Age Category filters should be reflected in the chart and their status should be marked in the legend by a sheer grey box.
  • Confirm you can select/un-select a Age Category label/colored box from the Query Age Category legend and confirm the chart updates.
  • Confirm that changing the Status Group to Query Status updates the chart label to Query Status and the legend options to the Query Status filters, and that the chart itself updates.
  • Confirm the filters selected in the legend are marked by a sheer grey box and those not selected are not highlighted. Confirm that the same filters are highlighted in the Query Age Category or Query Status filter box.
  • Change the input on the Site filter, confirm the chart updates.
  • When bar arrangement is set to stacked, confirm that the y-axis has one bar for each variable.
  • When bar arrangement is set to grouped, confirm that the y-axis has a set of bars for each status within a variable.
  • Confirm the default setting for the "Show First N Groups" filter is set to "All" instead of "10". Verify that it displays all of the results regardless of group
  • When Group by is set to Form: Field, select 10 under Show first N groups and confirm that it displays 10 results.
  • When Group by is set to Form: Field, select 25 under Show first N groups and confirm that it displays 25 results.
  • Confirm that Order Groups Alphabetically? is checked by default and that the items in the chart display in alphabetical order.
  • Unselect the Order Groups Alphabetically? checkbox and confirm that the data in the chart changes to be sorted by magnitude (largest to smallest number of queries) instead of alphabetically.
  • Confirm that checking the Order Groups Alphabetically? box causes the chart to again sort in alphabetical order.
  • Confirm you are able to see the total number of queries on the chart itself, it should appear in () next to "# of Queries" on the x-axis header.
  • Confirm that when the Show All setting is selected the chart does not indicate that there are "X More" items that could be displayed on the y-axis.
  • Confirm that using grouped bar arrangement and different filter combinations, the X-axis adjusts as expected and there are no visual abnormalities
  • Confirm that when adding the filters below that the other controls do not change from multi-selects to drop downs Add this in CAT settings to add two filters: { "filters": [ { "value_col": "querytext", "label": "Text" }, { "value_col": "queryresolveddt", "label": "ResolveDate" } ] }
  • Confirm the settings form still appears
  • Confirm that the query statuses specified here are presented by query age category rather than by query status when Status Group is set to Query Age
  • Add and remove query age cutoffs (like [14, 28, 56, 112] instead of ['0-2 weeks', '2-4 weeks', ...]) and verify the Query Age filter and Status Group update as expected
  • Confirm that when Status Group is set to Query Age the colors of Answered, Closed, and Cancelled categories should match the colors of the same categories when Status Group is set to Query Status
  • Confirm the settings form in CAT should allow the specification of the initial Status Group variable and the initial bar arrangement ( color_by_col: querystatus bar_arrangement: grouped )
  • Confirm there is a select all option/checkbox for each filter
  • Confirm each control has a tooltip when hovering
  • Verify Answered appears in the Query Age filter and legend
  • Verify Query Recency has a max option of >30 days
  • Verify that the query statuses specified here are presented by query age category rather than by query status when Status Group is set to Query Age
  • Confirm that selecting or deselecting a Query Age filter option should select or deselect the corresponding option in the Query Status filter, and vice versa. For instance, selecting a Query Age category of Answered should select the Query Status category of Answered. (The Open query status is an exception as it maps to multiple Query Age categories. Selecting 0-2 wks in Query Age should select Open in Query Status, but deselecting a single Open Query Age category should not deselect Open)
  • Confirm the legend filter should behave the same as the previous test, i.e. the legend filter should update as the filters update and the filters should update as the legend updates.
  • Confirm the Select/Deselect All checkboxes should update as expected for the Query Age and Query Status filters

Chart and Listing

  • Hover over a form label to show the form name.
  • Hover over a form: field label to show the form and field name.
  • Hover over a bar to show the number of queries associated with that group and status.
  • Click on a bar to highlight it and then confirm that the data listing table updates to only show records from the selected bar.
  • Confirm that you can click on and select/highlight multiple bars in the chart, and that the data listing updates and adds records accordingly.
  • Confirm the Reset chart button does not overlap the legend, regardless of which Group by option is selected.
  • Confirm when Group by is set to Form, clicking a y-axis tick label should update the Form filter to the clicked value and the Group by control to Form: Field. Also confirm, the Form filter, the y-axis label, and the Group by control label should all briefly display with underlined red text
  • Confirm listing column headers have tooltips
  • Confirm hovering over an extremely narrow bar shouldn't cause it to disappear (example shown here: https://github.com/RhoInc/query-overview/issues/130)

Data Listing and Download

  • Confirm that the data listing is always visible below the chart.
  • Confirm that changing the input on the data filters causes the data listing to change what it displays to match the chosen filters.
  • Confirm that selecting bars in the chart causes the data listing to change what it displays to match the selected bar(s).
  • Confirm that search and sorting work in the data listing.
  • Confirm that the Query Age (days) and Query Recency (days) columns sort numerically and not alphanumerically (other columns should still sort alphanumerically).
  • Confirm that the Reset listing button resets the data listing to match the default view that corresponds to selected filters, and removes any search term or sorting that was in place.
  • Confirm that the export CSV button displays by default at the bottom of the data listing, and that you can successfully export the data.
  • Confirm switching Maximum Length of Cell Text from 100 to 5 truncates the text of variables in the table. Check the cells to make sure they're truncating and displaying the full text when hovered over.
  • Confirm that a scroll bar appears if the listing table is larger than the container page and the scroll bar appears above the table
  • Confirm that zooming out so the table fits on the page makes the scroll bar disappear

Reset Chart

  • When the filters and controls have been used, confirm that selecting the Reset chart button clears the input and returns the chart it its default settings.
  • Confirm clicking in the white space of the chart canvas after clicking one or more bars deselects all bars and resets the listing. Also, confirm clicking the Reset listing button does the same

Wiki Page

Clone this wiki locally