RiverWare 6.7 MRM Configuration Script Action Support / May 2015
Phil Weinstein, David Neumann, Patrick Lynn, Edie Zagona, CADSWES
Edit: 5-18-2015 (b) ... see also original planning document.

New RiverWare Script Actions

Seven new MRM configuration-related script action types have been developed for RiverWare 6.7. There are now 36 different script action types. The new actions all modify a named MRM configuration within the current RiverWare model. The modified MRM properties are all represented on particular tabs within the MRM Configuration dialog, as indicated in this table:

MRM Config Dialog Tab New Script Action
Tab 1 Description 1 Set MRM Descriptor
Tab 2 Output 2 Configure MRM Output
Tab 3 Run Parameters 3 Set MRM Run Range
Tab 4 Policy 4 Set MRM Ruleset
Tab 5 Input 5 Configure MRM Index Sequential
6 Configure MRM Input DMI
7 Enable MRM Distributed Runs

Execution of these script actions modify the cited MRM configuration.  If an MRM configuration dialog is open for an affected MRM, the effect of the script on the MRM configuration is immediately reflected in that dialog.  If the user had made any changes in an open MRM configuration dialog which had not yet been applied, those changes are automatically applied before the script action is executed. 

RiverWare Script Action Names

RiverWare 6.7 now supports 36 script action types. The new actions described in this document are listed here in bold.

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


*Previously implemented MRM-related
Script Action: (#11) Execute MRM Run.

(Tab 1) MRM Description / Descriptors

New Action 1: Set MRM Descriptor

Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. MRM Configuration ... MRM Selector
  4. Keyword
  5. Value

(Tab 2) MRM Output Configuration

New Action 2: Configure MRM Output

Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. MRM 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 ... Yes/No

When the "Allow Control File Editing" setting is "Yes", a file chooser control is shown in the Script Dashboard:

(Tab 3) MRM Run Parameters Configuration

New Action 3: Set MRM Run Range

Settings:

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

When the "Allow Start/End Date Editing" settings are "Yes", corresponding Date/Time selector controls are shown in the Script Dashboard:

(Tab 4) MRM Change Ruleset Configuration

New 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

In this example, the first (of three) Rulesets in the MRM Policy configuration is replaced with the "ruleLanguage.rls" ruleset.

(Tab 5) MRM Input Configuration

New 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)

New 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)

New Action 7: Enable MRM Distributed Runs

Settings:

  1. Show in Dashboard ... Yes/No
  2. Display Text
  3. Configuration ... MRM Selector
  4. Enable or Disable

Note: If enabling (not disabling) Distributed Runs, an error is generated if the current MRM configuration settings don't support distributed runs.

--- (end) ---