Use Case Description

 

  1. UC-4 Save / Restore execom
    1. Brief Description

    This use case represents how the Budget Analyst interacts with the system to save an execom and restore an execom for editing. An execom is a file which contains interactively predefined input parameters for running a report.

     

  2. Flow of Events
    1. Basic Flow
  1. Budget Analyst performs Use Case Run Report or Use Case Run Report With Options.
  2. Budget Analyst selects to save the execom
  3. (System prompts Budget Analyst for execom name.)
  4. Budget Analyst inputs execom name.
  5. (System checks to see if execom name already exists.) [A-1]
  6. (System saves execom and informs Budget Analyst that operation was successful.)

 

    1. Alternate Flows
      1. A-1 - Execom name already exists and Budget Analyst chooses to overwrite existing execom.
  1. (System informs Budget Analyst that execom name already exists and prompts for overwrite.)
  2. Budget Analyst chooses to overwrite the existing execom.
  3. (System informs Budget Analyst that execom has been saved.)

 

      1. A-2 - Budget Analyst selects an execom for viewing.
  1. parameters are displayed
  2. cancel {TO DO: do not allow Budget Analyst to change to edit from here?}

 

      1. A-3 - Budget Analyst selects an execom for deletion.

        2. (System confirms delete?)

         

      2. A-4 - Budget Analyst selects an execom for editing.
  1. Budget Analyst selects to edit an execom.
  2. (System fills GUI components with inputs from execom, including parameters list.)
  3. Budget Analyst edits execom according to Use Case Run Report or Use Case Run Report With Options.

 

      1. E-1 Parameters for Run Report has not been supplied - {TO DO: would violate precondition}

        2.  

      2. E-2 Dependent options have not been selected.

        3.  

      3. E-2 Input parameters for options have not been supplied
        4.

        {TO DO: so we will not allow a Budget Analyst to save an execom "in progress" (e.g., under development without all necessary parameters.}

         

      4. E-1 - Execom name already exists.

 

  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.

    ABIDES - The legacy system that actually produces the report.

     

  2. Pre-Conditions

    3. Budget Analyst is logged into the system and has made at least the minimum appropriate selections required to run a report. If options are included, the Budget Analyst has made the appropriate precedent and subsequent options selections and provided the required input parameters.

     

  3. Post-Conditions

    4. The system successfully saves the execom.

  4. Extension Points

    5. None.

     

  5. Supplemental Requirements

    6. Execom format

    Parameter Example

    file comment #!/bin/sh

    operating system command fa_rpt -run_execom $@ << RUN1

    report type rb

    create data or report rf

    option choices uh,bh

    exercise current

    input files tovercas_1

    appn choices all

    keep or delete choices n

    break choices appn

    starting fiscal year 88

    shell command RUN1

    The above parameters are positional and required.

    Further input may be required for some options. If further input is required it is positioned after starting fiscal year and in the order that the option choices are listed so that the legacy system can match the inputs to a particular option.

    Note: If the following text "5 = rptbrk {rb}" appears on the legacy system menu, the existing code can handle each of the following: 1) rptbrk {rb}, 2) rptbrk, and 3) rb.

     

  6. Open Issues

{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: determine if there will be a proliferation of execoms now and if this will cause any problems.}

{TO DO: remote or locally, prefer remote - current implementation saves them even if they aren’t reusable or visible to the GUI Budget Analyst yer.}

{TO DO: consider TUI execoms. GUI execoms may have to reside in a different directory than the TUI ones if TUI can’t run GUI execoms.}

{TO DO: probably easier to share if saved remotely, probably different directory than TUI execoms.}

{TO DO: execom extension is ".x"}

{TO DO: consider TUI execoms.}

{TO DO: move to Use Case Run Reports - Save the locally report as *html, *.txt., *.doc, etc.}

{TO DO: consider Budget Analyst selects to view an existing report

(stored externally only) - probably not to chg location of execoms (local, remote)

(if stored locally, put in directory separate from executable, etc.)}

{TO DO: consider Delete an existing report}