Functional Requirements Template by leader6

VIEWS: 9 PAGES: 7

									                 Tennessee
       Department of Children’s Services
                   Office of Information Systems
                         500 Deaderick Street
                         Nashville, TN 37243



                 Functional Requirements Document
Project Title:

       Functional Assessment WEB Application
                   Enhancements
                              (Phase 2B)
     PROJECT: Functional Assessment WEB Application Enhancements (Phase 2B)                                               Revision: 2




                                            Table of Contents

1.      PROJECT SCOPE ..................................................................................................................... 3
2.      BENEFITS TO THE BUSINESS .............................................................................................. 3
3.      PROJECT ASSUMPTIONS ...................................................................................................... 3
4.      PROJECT CONSTRAINTS ...................................................................................................... 3
5.      REVISION HISTORY............................................................................................................... 3
6.      FUNCTIONAL REQUIREMENTS .......................................................................................... 3
7.      APPROVALS ............................................................................................................................ 6
8.      APPENDIXES ........................................................................................................................... 7




     Saved: 2012-10-05 @ 11:21 PM       Author: Michael VanGalder                  Printed: 2012-10-05 11:21:00 PM        Page: 2 of 7
            TN Department of Children’s Services CONFIDENTIAL                    File: 39c835a0-76ed-45cc-9d71-66ce7880725c.doc
   PROJECT: Functional Assessment WEB Application Enhancements (Phase 2B)                             Revision: 2

1. PROJECT SCOPE
     1.1. Implement several enhancements that will improve the Functional Assessment (FA)
          user satisfaction with the FA WEB application.

2. BENEFITS TO THE BUSINESS
     2.1. Facilitate user adoption of the FA WEB application as a tool to capture FA
          information.

3. PROJECT ASSUMPTIONS
     3.1. This project does not include any major FA WEB application changes.

4. PROJECT CONSTRAINTS
     4.1. Limited OIS WEB Developer resources.

5. REVISION HISTORY
Revision       Date                By                                         Description
   0         06/23/2006     M. W. VanGalder      Original DRAFT.
  1.0        06/28/2006     M. W. VanGalder      Submitted to stakeholders for approval.
  1.1        07/07/2006     M. W. VanGalder      Added appendix 8.1 (session time out warning functionality diagram).
  2.0        10/23/2006     M. W. VanGalder      Removed FR1, FR2, & appendix 8.1. Major rewrite of FR3 and FR4.


6. FUNCTIONAL REQUIREMENTS
    FR1. The Functional Assessment (FA) WEB application must provide users with a warning
         before their FA session times out. Also see appendix 8.1.
              Objective is to minimize the loss of unsaved user input.
        FR1.BR1. The session time out warning must be very obvious to the user.
        FR1.BR2. The user must be required to acknowledge the warning before they can resume
                 work in their local FA session.
             FR1.BR2.1. If the user acknowledges the warning before their local FA session times out, the server timer
                        for their session should be reset to the maximum allowed time (currently 20 minutes).
               FR1.BR2.1.1. Users must be aware that acknowledging the warning will restart their timer.
               FR1.BR2.1.2. The user must be able to resume work from where they were before they received the
                             warning.
             FR1.BR2.2. If the user acknowledges the warning after their local FA session has timed out, they must be
                        advised that their session has timed out, that any unsaved entry will not be saved, and that
                        they must log in again.
               FR1.BR2.2.1. When the user’s session times out, they should be left in a state that would allow a user
                             to copy their unsaved input and paste it into another application like Microsoft Word.
                             The user could then log back into the FA WEB application and copy and paste the
                             information into the appropriate FA field.
                              NOTE: Users will have to be trained to take advantage of this feature.
               FR1.BR2.2.2. If possible, the user’s local FA session should not allow the user to continue working
                             (except for the copy) after the user has been advised that their session has timed out.
        FR1.BR3. The session time out warning must not cause the user to loose their current
                 location within the FA application.
        FR1.BR4. The session time out warning must not cause the user to loose any unsaved
                 entries.
   Saved: 2012-10-05 @ 11:21 PM       Author: Michael VanGalder     Printed: 2012-10-05 11:21:00 PM        Page: 3 of 7
          TN Department of Children’s Services CONFIDENTIAL       File: 39c835a0-76ed-45cc-9d71-66ce7880725c.doc
PROJECT: Functional Assessment WEB Application Enhancements (Phase 2B)                             Revision: 2
     FR1.BR5. The FA user must receive this session time out warning at least 5 minutes before
              their local FA session breaks communication with the FA server due to time out.
     FR1.BR6. The user must not get any FA session time out warnings if communication
              between the local session and the parent application is broken for any reason other
              than the time out of the local session.
          FR1.BR6.1. The process to trigger a FA session time out warning must be terminated if communication
                     between the local session and the parent application is broken for any reason other than the
                     time out of the local session.
 NOTE: Document revision 2.0: Functional requirements FR1 through FR1.BR6.1, related to providing
       user session time out warnings, were removed because they are no longer needed. As of the
       September 13, 2006 FA WEB application upgrade, the users are no longer impacted by session
       time out. Users are not disconnected from the application server regardless of how long their
       local session has been “idle”.

 FR2. The FA WEB application must provide logged in users with a warning when their local
      FA session is no longer able to communicate with the parent FA application (on the main
      server).
           Objective is to minimize situations where the user enters or continues to enter information,
            which they will not be able to save, into their local FA session.
     FR2.BR1. The process to check for lost communication must be repeated every 5 minutes.
                    The maximum user exposure is 5 minutes of input being lost. This condition will
                     occur when communication is lost immediately after a check process is completed.
                    NOTE: If the system resource utilization, to perform the lost communication checks,
                            results in poor application/system performance, the time interval between
                            checks may have to be increased.
     FR2.BR2. The lost communication warning must be very obvious to the user.
     FR2.BR3. The lost communication warning must advise the user that their FA session is
              unable to communicate with the parent FA application, that they will not be able
              to save any unsaved entries, and that they will have to log back into the FA
              application after it is available again.
     FR2.BR4. The user must be required to acknowledge the warning before they can return to
              their local FA session.
     FR2.BR5. When the user’s local FA session is unable to communicate with the parent FA
              application, the user should be left in a state that would allow them to copy their
              unsaved input and paste it into another application like Microsoft Word. The user
              could then log back into the FA WEB application and copy and paste the
              information into the appropriate FA field.
                  NOTE: Users will have to be trained to take advantage of this feature.
          FR2.BR5.1. If possible, the user’s local FA session should not allow the user to continue working (except
                     to copy) after the user acknowledges that it is no longer communicating with the parent FA
                     application.
     FR2.BR6. The user must not get any lost communication warnings if their FA WEB
              application session has timed out.
          FR2.BR6.1. The process to trigger a lost communication warning must be terminated if communication
                     between the local session and the parent application is broken because the session timed out.
 NOTE: Document revision 2.0: Functional requirements FR2 through FR2.BR6.1, related to FA WEB
       application or application server communication breakdown advisory, were removed. The FA
       WEB application’s stability has been greatly improved since this enhancement was requested.
       Therefore, the development effort and subsequent application overhead (to continuously monitor
       the application status) that this requirement would drive isn’t necessary at this time.

Saved: 2012-10-05 @ 11:21 PM       Author: Michael VanGalder     Printed: 2012-10-05 11:21:00 PM        Page: 4 of 7
       TN Department of Children’s Services CONFIDENTIAL       File: 39c835a0-76ed-45cc-9d71-66ce7880725c.doc
PROJECT: Functional Assessment WEB Application Enhancements (Phase 2B)                              Revision: 2
 FR3. Within a FA WEB application domain, for each section that has a ‘SAVE’ button, the
      application must require advise/warn a user to click the “SAVE” or “CLEAR” button for
      any entries they make, within the section, before they are allowed to take any action,
      within the domain, that would cause their unsaved entry(s) to be lost.
      Exception: Due to the significant programming effort that would be required, users will NOT
                   be warned if they elect to exit the application or to leave one domain and go to
                   another without saving and/or clearing their entries. The unsaved entries will be lost.
         NOTE: Users often are able to input multiple entries before they must or should perform a save.
                  EXAMPLE: In the ‘Family Story’ section of the ‘Service History’ domain, the user can enter a
                           text narrative and may select a sibling to “Add to File of…”.
                  EXAMPLE: In the ‘Record Check’ section of the ‘Assessment Tools’ domain, the user must
                           check one or more record types, enter the “Date Requested” and/or “Date Received”
                           for each checked record type, and may select a sibling to “Add to File of…”.
     FR3.BR1. The advisory/warning must be repeated until each of the user’s unsaved entries
              has been saved or cleared.
          FR3.BR1.1. The user’s selection regarding if a text narrative is to be added to a sibling’s FA record
                     (“Add to File of…”) must be accommodated at the time the text narrative is finally saved.
     FR3.BR2. For each section that has a “SAVE” button, after adding information into one or
              more entry fields, the user must be required to save or clear their unsaved entry(s)
              before:
          FR3.BR2.1. Moving their cursor into an entry field of another section (section with different “SAVE”
                     button).
          FR3.BR2.2. They are able to edit a previously saved entry (in this or any other section).
          FR3.BR2.3. They can move from the current domain to another domain.
          FR3.BR2.4. They can exit their FA WEB application session.
 FR4. Within a FA WEB application domain, while using the edit feature on a previously saved
      entry, if the user moves focus from the text edit box, to somewhere else in the domain,
      without performing a save (by clicking the “UPDATE” button) or without canceling their
      edits (by clicking the “CANCEL” button) the FA WEB application must advise the user
      that any edits they had made have been lost and cannot be saved. While using the edit
      feature on a previously saved entry, the FA WEB application must require the user to
      click the “UPDATE” or “CANCEL” button before they are allowed to take any action that
      would cause their unsaved edit to be lost.
      Exception: Due to the significant programming effort that would be required, users will NOT
                   be advised/warned if they elect to exit the application or to leave one domain and go
                   to another without saving and/or canceling their edit. The unsaved edit will be lost.
                   The same significant programming effort precludes the application from warning
                   the user before they loose their edits when they move focus from the text edit box.
         NOTE: The application prohibits users from concurrently initiating multiple edit operations.
     FR4.BR1. While they have an active edit, the user must be required to click the “UPDATE”
              or “CANCEL” button before:
          FR4.BR1.1.    Moving their cursor into any data entry field (in this or any other section).
          FR4.BR1.2.    They can edit a different, previously saved, entry (in this or any other section).
          FR4.BR1.3.    They can move from the current domain to another domain.
          FR4.BR1.4.    They can exit their FA WEB application session.
 FR5. If the FA WEB application is unavailable, when a user tries to log in, the user must be
      advised that the application is unavailable instead of getting a message that the login
      information they supplied is invalid.


Saved: 2012-10-05 @ 11:21 PM       Author: Michael VanGalder      Printed: 2012-10-05 11:21:00 PM        Page: 5 of 7
       TN Department of Children’s Services CONFIDENTIAL        File: 39c835a0-76ed-45cc-9d71-66ce7880725c.doc
   PROJECT: Functional Assessment WEB Application Enhancements (Phase 2B)                            Revision: 2


 7. APPROVALS


Thomas Jones       Director Functional Assessment

. signature on file ______                 .                 . 30-Oct-2006          .
Signature                                                    Date



Dr. Linda Fenderson-Doss          Program Coordinator, Functional Assessment Division

. signature on file ______                 .                 . 30-Oct-2006          .
Signature                                                    Date




  Saved: 2012-10-05 @ 11:21 PM       Author: Michael VanGalder     Printed: 2012-10-05 11:21:00 PM        Page: 6 of 7
         TN Department of Children’s Services CONFIDENTIAL       File: 39c835a0-76ed-45cc-9d71-66ce7880725c.doc
   PROJECT: Functional Assessment WEB Application Enhancements (Phase 2B)                            Revision: 2

 8.      APPENDIXES
8.1.      Diagram of User Session Time Out Warning Functionality (ref. FR1)
       NOTE: Document revision 2.0: Appendix 8.1, user session time out warning flow diagram, was removed
             because it is no longer needed. As of the September 13, 2006 FA WEB application upgrade, the users
             are no longer impacted by session time out. Users are not disconnected from the application server
             regardless of how long their local session has been “idle”.




  Saved: 2012-10-05 @ 11:21 PM       Author: Michael VanGalder     Printed: 2012-10-05 11:21:00 PM        Page: 7 of 7
         TN Department of Children’s Services CONFIDENTIAL       File: 39c835a0-76ed-45cc-9d71-66ce7880725c.doc

								
To top