DESIGN: Partial MRM Configuration Script Action Support / RW 6.7 / May 2015
Funding: BOR UC, Discretionary Development (Spring 2015), RiverWare 6.7
Phil, Edit: 5-16-2015 ... see also completed feature document.

Revision History:

Requirements Statement

Improve RiverWare’s Script Manager to allow scripts to edit the MRM configuration as follows:

  1. set descriptor key/value pair
  2. change output control file
  3. enable/disable NetCDF
  4. enable/disable CSV output
  5. modify run parameters
  6. change ruleset
  7. Input tab:
    1. change index sequential number of runs, initial offset, interval
    2. DMI repeat, and
    3. enable/disable distributed runs.

New Proposed Actions Summary

These are also presented in subsequent sections, (a) with respect to corresponding configuration dialog tab, and (b) alongside the 29 previously implemented Script actions.

  1. Set MRM Descriptor
  2. Configure MRM Output
  3. Set MRM Run Range
  4. Set MRM Ruleset
  5. Configure MRM Index Sequential
  6. Configure MRM Input DMI
  7. Enable/Disable MRM Distrib. Runs

MRM configuration editor controls for the relevant configuration settings

These are represented on these four tabs of the MRM Configuration Dialog. Details follow.

Tab Config Controls Proposed New Script Action
Tab 1 Description (a) set descriptor key/value pair 1 Set MRM Descriptor
Tab 2 Output (b) change output control file
(c) enable/disable NetCDF
(d) enable/disable CSV output		 2 Configure MRM Output
Tab 3 Run Parameters (e) modify run parameters 3 Set MRM Run Range
Tab 4 Policy (f) change ruleset 4 Set MRM Ruleset
Tab 5 Input (g.i) change index sequential number of runs, initial offset, interval
 5 Configure MRM Index Sequential
(g.ii) DMI repeat 6 Configure MRM Input DMI
(g.iii) enable/disable distributed runs 7 Enable/Disable MRM Distrib. Runs

Script Action Names

Existing New, Proposed
  1. Clear DMI Values
  2. Clear Scalar Slot Values
  3. Clear Table Slot Values
  4. Create Snapshot
  5. Enable RPL Item
  6. Execute DMI
  7. Execute MRM Run*
  8. Execute Run
  9. Generate Output Device
  10. Load Ruleset
  11. Load Goal Set
  12. Memo
  13. Open Global Functions Set
  14. Open SCT
  15. Open Slots
  16. Reorder RPL Set
  17. Save Model
  18. Set Account Method
  19. Set Accounting Period
  20. Set Controller
  21. Set Init. Rules Exec. Flag
  22. Set Method
  23. Set Run Range
  24. Set Scalar Slot Value
  25. Set Series Slot Flags
  26. Set Series Slot Values
  27. Set Table Slot Value
  28. Synchronize Objects
  29. Synchronize Slots
  1. Set MRM Descriptor
  2. Configure MRM Output
  3. Set MRM Run Range
  4. Set MRM Ruleset
  5. Configure MRM Index Sequential
  6. Configure MRM Input DMI
  7. Enable/Disable MRM Distrib. Runs

*Existing MRM-related Script Action (Execute MRM Run) Settings:

(Tab 1) MRM Description / Descriptors

Script Action (1): Set MRM Descriptor
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Keyword
  5. Value
  6.  Allow Value Editing   (not needed)

(Tab 2) MRM Output Configuration

Script Action (2): Configure MRM Output
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Control File ... file selection (blank: don't change)
  5. Generate CSV Files ... Yes/No
  6. Generate NetCDF Files ... Yes/No
  7. Allow Control File Editing

(Tab 3) MRM Run Parameters Configuration

Similar existing script action: Set Run Range, settings:

Script Action (3): Set MRM Run Range
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Start Date ...
  5. End Date
  6. Allow Start Date Editing ... Yes/No
  7. Allow End Date Editing ... Yes/No

(Tab 4) MRM Change Ruleset Configuration

Similar existing script action: Load Ruleset, settings:

Script Action (4): Set MRM Ruleset
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Ruleset ... Positive Integer (spin box)
  5. File Name ... file chooser
  6.  Confirm Replacement  ... Yes/No  (not needed)

(Tab 5) MRM Input Configuration

Script Action (5): Configure MRM Index Sequential
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Number of Runs ... integer (spin box)
  5. Initial Offset ... integer (spin box)
  6. Interval ... integer (spin box)
  7.  Allow Number of Runs Editing  ... Yes/No  (not needed)
  8.  Allow Initial Offset Editing  ... Yes/No  (not needed)
  9.  Allow Interval Editing  ... Yes/No  (not needed)

continued ...

Script Action (6): Configure MRM Input DMI
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. DMI Name ... DMI Selector
  5. Repeat Count ... integer (spin box)
  6.  Allow Repeat Count Editing  ... Yes/No  (not needed)

Script Action (7): Enable/Disable MRM Distrib. Runs
Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Enable ... Yes/No
  5.  Allow Enable Editing  ... Yes/No  (not needed)

--- (end) ---