Skip directly to searchSkip directly to the site navigationSkip directly to the page's main content

IBIS-Q System Documentation - Maintenance and Testing

Maintaining and Testing Modules

Establish general procedures for testing newly created modules before they are released externally. In addition, it is a good practice to capture trouble reports or user questions, and use those issues (and their resolutions) for ongoing maintenance. This chapter includes the following:

Basic Checklist for Completing Module Interface Files

Check each module for proper completion of the following items:
# Verify: Notes
1 Proper "Tab" indenturing The Aioob tool does this automatically. Open your xml file in Aioob (in the xml window) and save it. Make sure there are no spaces, and that it appears to be using only tabs (if it looks like a tree format, switch over to the xml window).
2 All the documents are well formed. Most of the tools have this as an option.
3 All the module measure selections are hittable. Each measure defined within your module needs a selection on the menu or from the "Measure Selection" page so that users can navigate to each module/measure.
4 Navigation path of the module measure is correct. This should specify the menu selections and quick measure selection (if applicable otherwise the advanced selections) needed to get to this measure.
5 Each module's Overview section is correct. There should be a paragraph or two of relevant text, then a statement about changing user options, followed by the Getting Started section.
6 Module name element, module and configuration titles are correct. The module name tag should contain the name of the module.xml files. Module and configuration titles should conform to the established standards.
7 Each configuration's data notes, sources, and issues are correct. Every configuration must have at least one data source. Make sure that all data notes and data issues sections make sense with the configuration selected.
8 All the Steps and selections within those steps are visible and correct. Check each selection to ensure that the appropriate options are listed. In general, the 'unknown' option should not be visible. In the last step, check that the 'display by' options available are correct.
9 One and only one answer can be selected for any option button question. If option buttons are used then all answers must use the same name or the user will be able to incorrectly make multiple option button selections. Checkboxes or scrolling lists are the correct user interface control for multi-selects). (There are a few cases where multiple option buttons may be selected, but these are rare.)
10 All step, question, and answer titles are correct. Check spelling, grammar and conformance to established standards.
11 Each step has a default selection upon entry. Upon initial entry to every step, you should be able see the default selection already selected. This is done with the <SELECTED_DIMENSIONS>, <SELECTED_DIMENSION> elements. The default selection will display in the step or question title text.
12 Every type of value for each measure has been tested. Test using the following general procedure:
  1. Open the new module in browser window.
  2. For each type of variable (e.g. year, each and every type of year group, gender, each and every type of age group, county, lhd, small area, etc.) do the following steps and check to make sure the data returned is correct:
    1. Test the "use all the values" for that variable. Do NOT do any special 2d grouping - only group by that variable type.
    2. Repeat the above test but select all the values except one.
    3. Repeat the above but select the one value that was not selected in the previous step. This process ensures all the variables values work. Each possible variables should be documented when tested.
13 Each module's measure result XML has been validated. For each module.xml, do the following:
  1. Submit any query for the module.
  2. On the results page, press the [Show XML] button.
  3. Save the XML to your local hard drive (File/Save As/then enter the path - typically c:\tomcat\webapps\ibisph-view\xml\query\Query.xml).
  4. Open the newly saved XML with the XML editor of your choice that supports XML validation.
  5. Insert the XSD statement just below the XML prolog so that the top of the file looks like this: <?xml version="1.0" encoding="UTF-8"?><QUERY xmlns:xsi= xsi:noNamespaceSchemaLocation=" \Tomcat\webapps\ibisph-view\xml\query\module.xsd"> NOTE: If you put your newly created XML document in the same directory as the module.xsd file then the above can be:>?xml version="1.0" encoding="UTF-8"?><QUERY xmlns:xsi= xsi:noNamespaceSchemaLocation="module.xsd">.
  6. Choose the validate XML option. This is either a button or a menu option and is dependent on the tool being used.
  7. If the validation reports an error then fix the module xml. For expediency, also fix the sample query xml file and proceed with validation so that time is not wasted fixing one problem then having to rerun the entire query, inserting the XSD statement etc.
14 Each dimension selection for both row and column "group by" for the 2d table have been tested. Every combination of the possible groupings should be made and the results checked. Check the values and verify that the titles are displayed correctly.
15 Each drill-down option on the results page has been tested. Pay attention to the area being drilled down on. The new result total should match the item being drilled down on. For example: If you're drilling down on Salt Lake County with a new group by of Year, the current value for Salt Lake County should match the total of all years on the new drilled down results page
16 The values are formatted. If the value is a percentage, make sure it's 45.5% and not 0.455. If the value is large make sure that commas are shown e.g. 1000000 should be 1,000,000. If the value is a dollar amount make sure it has a "$" symbol.
17 The totals values are displayed and sum correctly. Total values should be present on both the 2d table and the data list. You don't need to sum each row and column but please check that 1 row and 1 column sums correctly
The information provided was retrieved on: Sat, 18 September 2021 14:23:47.

Content updated: Fri, 22 Feb 2008 14:13:07 MST