Use Case Description

  1. UC-2 - Run Report
    1. Use Case Summary

    This use case represents the actions (input parameters) a Budget Analyst performs in order to create a Report Break without specifying any options (e.g., without selecting any changes to the standard report format, data selection criteria or calculations). The report either displays to the terminal, prints in the remote printer site or saves to a file on the remote server. The Budget Analyst also has the choice of extracting data based on the input parameters and downloading the data to the PC for use in spreadsheet software.

     

  2. Flow of Events
    1. Basic Flow
  1. Budget Analyst chooses to produce a new F&FP Report Break report from ABIDES-FE main frame.
  2. (System retrieves the Budget Analyst’s preferences for reports.)
  3. (System retrieves the Budget Analyst’s authorized exercises and appropriations.)
  4. (System displays F&FP Report Break Criteria screen using the retrieved preferences, exercises and appropriations.)
  5. Budget Analyst optionally modifies defaulted report type, and starting fiscal year (e.g., FY99).

    6. Specifying Exercises
  6. Budget Analyst selects one or more exercises.
  7. (System retrieves input files associated with selected exercises.)
  8. Budget Analyst selects one or more input files from selected exercises.
  9. Budget Analyst selects one or more appropriations.

    10. Specifying Appropriation Data Elements Content. Steps 10-15 repeat until Budget Analyst is satisfied with appropriation/data element/value criteria:

  10. (System retrieves lists of data elements based upon the appropriations chosen.)
  11. Budget Analyst selects to include ("keep") none, one or more data elements for the report content.
  12. (System displays intersection of all kept data elements for each of the input files.) [E-1])
  13. ???? Budget Analyst selects to clear one or more data elements chosen for keep.
  14. (System refines display of intersection of all kept data elements for each of the appropriations.) [E-1])
  15. TBD As Requirement or Fantasy: Budget Analyst selects one or more values for each data element kept.

    16. Specifying Breaks
  16. Budget Analyst selects one or more of the intersected data elements to break on.
  17. Budget Analyst adjusts sort order of data element breaks, if desired.

Running the Report
  1. Budget Analyst chooses to run the report with current criteria.
  2. (System validates minimal inputs.) [E-2], [E-3]
  3. (System begins activity of generating report. As it progresses, it provides Budget Analyst with status of running report [# pages, time to create, offer cancel].)
  4. (When complete, System makes system report results text available for viewing.)
  5. (System delivers the report to the destination requested (based on report type).)
  6. Budget Analyst can then print the report locally, save the report, and/or save the report criteria for another later execution.

 

    1. Alternate Flows
      1. A-1 - Budget Analyst deselects an exercise after input files have been selected
  1. Budget Analyst deselects an exercises.
  2. (System deselects all input files associated with that exercise.)

NOTE: maybe display pop-up which warns about the effects of doing this. Budget Analyst may turn warnings on and off.

 

      1. A-2 - Budget Analyst deselects an appropriation after data elements and/or breaks have been selected
  1. Budget Analyst deselects an appropriation
  2. (System deselects all data elements for keep/deletes (and data values associated with the data elements for keep/deletes) associated with that appropriation.)
  3. (System deselects all data elements for breaks associated with that appropriation.)

 

      1. A-3 - Budget Analyst deselects a keep or delete data element after data values for the data element have been selected.
  1. Budget Analyst deselects a keep data element.
  2. (System deselects all data values associated with the data element.)
  3. Budget Analyst deselects a delete data element.
  4. (System deselects all data values associated with the data element.)

 

      1. A-4 - Report prints remotely (report type: print)

        2. 1. (System informs Budget Analyst that report is printing.)

         

      2. A-5 - Report is saved to a File (report type: file)
  1. (System captures file name from remote server.)
  2. (System informs Budget Analyst that report has been saved to a file and the name of the file.)

 

      1. A-6 - Data are extracted for a Microfile download (report type: microfile)

        2. 1. (System informs Budget Analyst that [comma-delimited] file (name) has been created and imported to the PC - - alternatively: import into Excel and open Excel with the imported information.

         

      2. A-7 - Clear Lists after supplying input parameters.
  1. Budget Analyst selects clear
  2. (System prompts Budget Analyst to save execom first.)
  3. Budget Analyst selects cancel.
  4. (System removes prompt, clears lists, e.g., resets all UI components. And resumes steady state.)

{TO DO: should basic and options input parameters be handled separately?}

 

      1. A-8 - Clear Lists after supplying input parameters after prompt to save
  1. Budget Analyst selects clear
  2. (System prompts Budget Analyst to save execom first.) See Use Case Save/Restore Execom

Note: alternate path ends here.

 

      1. A-9 - Close without supplying any input parameters
  1. Budget Analyst selects Close.
  2. (System exits application).

 

      1. A-10 - Close after supplying input parameters, but not running the report and choosing save.
  1. Budget Analyst select Close.
  2. (System prompts Budget Analyst to save the execom.) [A-9-1 See Use Case Save/Restore Execom].
  3. (System ends application execution.)

 

      1. A-11 - Close after running a new report, but not choosing save.
  1. Budget Analyst selects Close.
  2. (System prompts Budget Analyst to save the execom.)
  3. Budget Analyst selects to exit w/o saving. [A-9-1 See Use Case Save/Restore Execom].

 

      1. A-12 - Change format of parameter listing
  1. Budget Analyst selects to change format of parameter listing.
  2. (System toggles parameters between between human readable display format and system codes format.)

 

      1. A-12 - Change application data

        2. This alternate path is not part of the current implementation. This path would allow the Budget Analyst to change from the default F&FP data to either Accounting or Funds Management data.

         

      2. E-1 Input data elements aren’t on the consolidated data element list.

        3. 1. (System reports an error if the data element is not on the consolidated data element menu.).

         

      3. E-2 Report to be run is ambiguous
  1. (System notifies Budget Analyst if predefined execom is selected and there are selections highlighted in the report builder interface components meaning that report to be run is ambiguous.) [E-1]
  2. Budget Analyst either clears input parameters or deselects predefined execom.

 

      1. E-3 Invalid input parameters

1. (System notifies Budget Analyst to please select inputs for any missing parameters.)

  1. Return to R-1.

 

      1. E-4 Report was not created (no valid records selected for input parameters, records zero balanced)

1. (System displays remote system message as to why execom was not run.)

(When report is run: System will inform Budget Analyst that zero records were selected if the data element values do not exist in the chosen file(s). Report is not run in this case.)

NOTE: System will interpret 92398 as valid input, but not existing in input file because input should have been 92398f (afpec).

{TO DO: more length and formatting errors?}

{TO DO: determine how GUI will handle situations where no records were found with the specified values. No report is produced.}

{TO DO: determine how GUI will handle situations where records zero balance. Why does this happen?}

 

  1. Participating Actors

    2. Budget Analyst - Any interactive user of the ABIDES-FE Report Break. It is assumed that they require reports to analyze the state of the budget.

     

  2. Pre-conditions

    3. Assume Budget Analyst is logged into the ABIDES-FE and is situated to access the main frame.

    Note: See [SR-2].

     

  3. Post-conditions

    4. Budget Analyst receives the report break with the data and in the disposition requested.

     

  4. Extension Points

    5. None.

     

  5. Supplemental Requirements
    6.

    [SR-1] Note: The phrase "one or more" implies multiple, disjoint selections are possible. For some users, many input selections will be available (> 200). These users and others may be helped by showing most used selections first in the lists and/or providing "type ahead" capability.

    [SR-2] As the Budget Analyst makes selections or deselections, this information is summarized in the Execom parameters list.

     

  6. Open Issues

{TO DO: display defaults in parameter list also}

{TO DO: which is best to use? Abbreviations? Both? Long names? for selections so that if menus change, programs will still run ?}

{TO DO: execom file is created everytime a report is run. Store these in a directory different than the TUI execoms? Will GUI run TUI execoms? Will TUI run GUI execoms? Delete GUI execoms after they run until save feature is implemented and GUI, TUI, directory issue has been solved?}

{TO DO: would release of AFE2FFPRB be useful without execom feature, e.g., running a report break without being able to save the input parameters after the Budget Analyst exits the current report break session?}

{TO DO: map to requirements}

{TO DO: desk check with screens}

{TO DO: identify system defaults where applicable}

{TO DO: check visibility, ease of access (most used first) of inputs in all cases.}

{TO DO: determine speed desired in relation to the speed provided by the legacy system.}

{TO DO: readily display help if it exists.}

{TO DO: display name of current exercise.}

{TO DO: make it flashy.}

{TO DO: consider undo.}

 

Other TO DOs:

{TO DO: Cache report, show number of pages, option not to display big reports (600 - 700 pages) on PC? Size will have an effect on choice of where report is printed (locally or in remote printer site. Budget Analyst may select to view a few pages of a large report - not possible to redirect to remote printer.}

{TO DO: Possible error? - report times out after 1 hour - can a report take longer than this to run?

{TO DO: Probably some reports may run over night. Can this application schedule the time a report is printed?

{TO DO: determine how to perform page breaks in a browser.}