Skip to content

Visual Analytics Full Documentation

Anthony Armatas edited this page Mar 6, 2017 · 9 revisions

Visual Analytics Full Documentation

High level overview of the Visual Analytics Software:

The software is implemented on a single web page and does not load other pages to access content. The software uses "slides" which bring data to the forefront of the single page. Any uses of the word "page" in the documentation is referring to a slide and not a traditional web page, unless otherwise stated.

  • Start Test

  • Allows the users to take the test.

  • Users have to input their access codes(UUIDs) given to them by the admin(Usually Boris).

    • After the users input has been confirmed they are taken to a page where they will take a test.
      • Each test will be part of a set. This set is created by the admin. See Admin-New Test Set.
    • In between each test is a waiting page which should distract the user to take the next test with fresher eyes.
    • After all tests in the set have been completed the user will be taken to a final thank you page which ,as the name suggests, thank the user for their time and suggest that they close the window.
  • Training

    • Introduces the users to the test itself and gives information on how to complete it.
    • The users do not need any permissions and are able to access it by simply clicking the "Begin Training" button.
    • The next two pages are respectively about giving an overview of each test, and how to actually submit your answers.
    • The page following the instructional pages is the practice test.
      • The practice test is generated nearly the same as the actual test.
        • A key difference is the way the results are generated. For the actual test the results are sent to, and calculated in the database. For the practice page the results are generated on the front end and are not *The Results page is final page in Training. *The results of the user's test score is calculated and displayed on the page so that the user may have a better understanding of the task being asked of them.
  • About

    • The About section lets the user know who created the software and its informs them of its general purpose without digging into the details.
  • Admin

    • The Admin page is where the administrators who will be using the software will be able to manipulate the tests and view the data.
    • The page requires A username and password to access, both of which are stored in the database and will be maintained by Boris after delivery.
    • After logging in the admin will be presented with four sections : The template list, the template modification section, the test set modification section, and the test list section.
      • Template List

        • This section lists all of the, admin created, test templates available for use.
        • There is a drop down filter which allows the admin to filter the templates by the type of graph they contain. The types of graphs being:
          • Star
          • Line
          • Polar
      • Template Modification

        • This section contains buttons leading to pages which preform functions with respect to their names : New Template, Delete Template, View Template
          • New Template
            • This page allows the admin to create a new test template.
            • The specifics of which include: The Test Id(Name), the type of graph, and the amount of data points used in its generation.
            • While the original implementation allowed the admin to have more control over the creation of the graph, to make the generation more in accordance to our clients wishes we had to strip some functionality away for more consistent and accurate data.
          • Delete Template
            • This button allows the admin to delete an existing test template.
            • The deletion is done in two parts. First by simply clicking the template desired for deletion in the Template Modification section. This will highlight the template. The second will be hitting the Delete Template button. This will delete the button from the page and the database.
            • If the template is currently in use in a test set, the software does not allow those templates to be deleted.
          • View Template
            • This page allows the admin to view an existing test template.
            • The use of this page is similar to that of the delete button in the sense that the admin must first click on the template they want to view first, and then click the View Template button.
            • After choosing a template the page populates with the number of data points and the type of test.
      • Test Set Modification

        • This section contains buttons leading to pages which preform functions with respect to their names : View Test Set, Export, Download, New Test Set, Delete Test, Open Test, and Close Test.
          • View Test Set
            • This page shows all the attributes of a test set including.
              • The Name of the test set.
              • The time the user has to wait in between tests.
              • The date and time the set of tests will close.
              • The total number of tests used in the set.
              • A list of the test templates used in the set.
            • The page also displays each of the access codes associated with the test set.
          • Export
            • This button exports a CSV (Comma seperated values) file from the server to the front end.
          • Download
            • This page allows the admin to download the exported CSV file to their PC.
          • New Test Set
            • This page allows the admin to create a new set of tests.
            • The admin can set the following for the test set:
              • A unique Test Set ID(Name)
              • The Allotted time the user has to take each test
              • The expiration date of the test set.
              • The number of access codes to be generated.
              • The wait time in between each test.
              • And a selection table which shows the existing test templates on the left, and allows the admin to add the tests, in the order that they will appear, to the test set.
          • Delete Test
            • This button allows the admin to delete an existing test set. This work
            • This works in the same way that the view and delete template buttons work.
          • Open Test
            • This button changes the setting of the current test set to running.
          • Close Test
            • This button changes the setting of the current test set to completed.
      • Test List

        • This section lists all of the, admin created, test sets available for use.
        • There is a drop down filter which allows the admin to filter the test sets by the their current status. The statuses of test sets are:
          • Running - currently in use
          • Parked - The test set has been created but not ready for use yet
          • Complete - The test set has reached its expiration date or has been closed manually
  • Progress Report

    • This report covers our progress at around February 8th, 2017.

    • Our progress includes, actual functionality implemented, structural changes from initial development of the software, and our plans to move forward from that date.

    • Functionality Implemented

      • We have the skeleton of the software implemented. This includes:
        • A button which should eventually take the user to the test page where they will take each test in their assigned test set.
        • A training page, with nearly completed instructional and training pages, as well as some preliminary practice and result pages.
        • An about page with the general idea of the software. Soon to be completed
        • A skeleton for the admin page, with an input for a username and password which is not connected to the back end.
        • A preliminary database which will be updated as the front end requires.
    • Structural Changes From Initial Development

      • We changed our original plan from using MongoDB to using Python/Flask & MySQL.
        • This was because some of the group had experience with Python/Flask & MySQL, where in contrast no one had ever used MongoDB before. We found it the safer option to learn and adapt to a database frame work that at least some of our members were familiar with.
      • We changed our original plan for implimenting the graphs as static images with overlays added by the fron end, to generating the graph images with an algorithm.
        • The team found that we could give more control to the admin and keep the entire software in-house (as opposed to generating the entire images outside of our software) by creating our own graphs, and in turn tests.
        • Creating them ourselves also allows up the opportunity to easily change the generation algorithm down the line, if the need be.
    • Plans To Move Forward

      • Filling out the start test page and have it procedural create pages which will auto populate with tests from their respective test sets.
      • Implement a function test for the practice page which is identical to the actual test but calculates the results on the front end and populates the results page which follows.
      • Implement a fully functional admin page which will
        • Allow the admin to create, delete, and modify types of tests they will distribute.
        • Add created tests to a set, so the users will be able to take more than one test with a single access code.
        • Create a button which allows the admin to generate a preselected amount of access codes for specific test sets.
        • Allow the admin to examine and export completed test data.
  • Stretch Goals

    • These are goals that, assuming we complete the software before the delivery date, we can add which will make the product more user friendly and/or functional, but are not a necessary core to the working functionality.
    • On the view template page, generate a graph of the proposed template in addition to the actual details shown, of the test template.
    • Improve the look and usability of the admin page, as per the advise of Mrs.Harrison.
      • This involves a visual restructuring of the main admin page as a whole.
    • A waiting game in between the tests.
      • Currently their is a timer with nothing to do. We hope to be able to implement a simple flash game so the user has something to do which will take their mind off of the test.
      • Currently we use the traditional paper based graphs for the training pages. We may implement graphs generated in the software, much like the actual tests but without the functionality.
You can’t perform that action at this time.