skip to main content
Automation Tools : Script Management : Action Type Settings Reference
Action Type Settings Reference
This section provides details about settings specific to each type of action.
 Clear DMI Values
Clear the values set by a DMI (by using the DMI invocation manager functionality).
 
Setting
Type
Notes
DMI Name
Text
Enter the DMI name or choose the DMI using the menu.
 Clear Scalar Slot Values
Clear the values on a set of Scalar Slots (i.e. set them to NaN).
 
Setting
Type
Notes
Slots
Slot Selection
Enter or choose one or more scalar slots for which you wish to clear the values.
 Clear Table Slot Values
Clear certain values on a set of Table slots (i.e. set them to Nan).
 
Setting
Type
Notes
Slots
Slot Selection
Enter or choose one or more table slots. The values in these slots will be cleared.
Row
Text
Specify the row as either the row number (zero based) or the row heading
Column
Text
Specify the column as either the column number (zero based) or column heading
 Configure MRM Index Sequential
For the specified MRM configuration, modify the configuration in terms of Index Sequential. This is shown on the Input tab in the MRM configuration. See “Index-sequential Runs” in Solution Approaches for details.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller
Number of Runs
Integer
Specify the Number of Runs
Initial Offset
Integer
Specify the Initial Offset
Interval
Integer
Specify the Interval
 Configure MRM Input DMI
For the specified MRM configuration, modify the configuration in terms of Input DMIs, particularly the repeat count. This is shown on the Input tab in the MRM configuration. See “Input” in Solution Approaches for details.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller.
DMI Name
Text
Choose the Input DMI to configure. This should already be selected in the MRM configuration.
Repeat Count
Integer
Specify the Repeat Count.
 Configure MRM Output
For the specified MRM configuration, modify the configuration in terms of the Output. This is shown on the Output tab in the MRM configuration. See “Output” in Solution Approaches for details.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller.
Control File
File Chooser
Enter the file path. See “Filename Information” for details.
Generate CSV Files
Yes/No
Specify whether or not to generate CSV output
Generate NetCDF Files
Yes/No
Specify whether or not to generate NetCDF output
Allow Control File Editing
Yes/No
Specify if you would like the control file to be editable on the dashboard.
 Create Slot Cache
Creates a slot cache that contains the current values of all series slots on the workspace, in the range of the current controller. See “Slot Cache” in User Interface for details on the cache.
Note:  The slot cache is under development. Contact riverware-support@colorado.edu for details and the current status of this feature.
 
Setting
Type
Notes
None
 
 
 Create Snapshot
Create a Snapshot of the specified slots.
 
Setting
Type
Notes
Slots
Slot Selection
Enter or choose one or more slots for which you wish to take a snapshot.
Snapshot Name
Text
Specify the name of the snapshot object to create.
Replace Existing Snapshot?
Yes/No
Choose to replace a snapshot of the same name. If No, then a unique name for the snapshot will be created.
 Divider
This item adds a divider to the Script Editor and Script Dashboard. It does not do anything in script execution; it is strictly for to provided a visual separation between actions. The Display Text can be used to add text to the divider.
 
Setting
Type
Notes
Divider Color
Color Chooser
Use the color chooser to select the background color for the divider.
 Enable Dispatching
For the specified objects, enable or disable the dispatch method execution. When disabled, the object icons on the workspace and in other dialogs appear dimmed.
 
Setting
Type
Notes
Objects
Object Selection
Choose the desired objects using the object selector.
Enable or Disable?
Enable Dispatching / Disable Dispatching
Specify Enable to enable dispatching. Specify Disable to disable dispatching of those objects.
 Enable MRM Distributed Runs
For the specified MRM configuration, specify whether to distribute concurrent runs to multiple processors on the same machine. See “Distributed Concurrent Runs” in Solution Approaches for details on distributed MRM.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller.
Enable or Disable?
Enable / Disable
Specify Enable to run in distributed mode. Specify Disable to run the concurrent runs on a single processor.
 Enable RPL Item
Enable or disable a RPL item (policy group, rule, method, or goal).
 
Setting
Type
Notes
Set
Single Selection
Choose the set to which the RPL item belongs.
Item
Single Selection
Use the RPL item chooser to select the item.
Enable or Disable?
Yes/No
Specify Yes to Enable or No to disable the specified item.
 Evaluate Expression Slots
Evaluate a set of expression slots.
 
Setting
Type
Notes
Slots
Slot Selection
Choose the slots using the selector.
 Execute DMI
Invoke a DMI or DMI group.
 
Setting
Type
Notes
DMI Name
Text
Enter the DMI name or choose the DMI using the menu.
 Execute MRM Run
Execute the specified MRM configuration.
 
Setting
Type
Notes
Configuration
Text
Enter the name of an MRM configuration you wish to run.
 Execute Run
Run the model.
 
Setting
Type
Notes
NA
 
 
 Execute Script
Execute a script from within this script.
Note:  The script called by this action cannot have additional Execute Script actions. Rephrased, a script cannot call a script that calls another script. Only one level of a script executing a script is allowed. Also, a script cannot call itself.
 
Setting
Type
Notes
Script Name
Text
Type the script name or choose the desired single script from the script selector.
 Generate Output Device
Generate the specified Output Device. This could be a file based device like a Model Report or a graphical device like a Plot Page.
 
Setting
Type
Notes
Device Name
Text
Enter or choose the name of a output device (plot, file, report, chart)
 Global Time Scroll
Scroll time and series displays to the specified symbolic date/time.
 
Setting
Type
Notes
Scroll to DateTime
Datetime
Allow Editing
Selection
Yes indicates that users should be allowed to override the start date in the Dashboard.
 Load Goal Set
Open and load a goal set (for Optimization runs).
 
Setting
Type
Notes
File name
Text
Enter the file path. See “Filename Information” for details.
Confirm Replacement
Yes/No
Yes indicates that if the specified set is already open, a dialog should be presented to confirm replacement of the existing set.
Show Dialog
Yes/No
When this setting is Yes, the RPL set dialog is shown when the action is executed. Otherwise, the set is loaded into the model, but not shown.
 Load Ruleset
Open and load a ruleset (for Rulebased Simulation runs).
 
Setting
Type
Notes
File name
Text
Enter the file path. See “Filename Information” for details.
Confirm Replacement
Yes/No
Yes indicates that if the specified set is already open, a dialog should be presented to confirm replacement of the existing set.
Show Dialog
Yes/No
When this setting is Yes, the RPL set dialog is shown when the action is executed. Otherwise, the set is loaded into the model, but not shown.
 Memo
Pause script execution and optionally open a confirmation dialog with your user specified message. While script execution is paused, you can interact with RiverWare or other applications in ways not directly supported by scripts. Select the script Continue button to resume the script execution.
 
Setting
Type
Notes
Explanation
Multi-line text
Enter the desired text. This will optionally be displayed in the memo dialog and or the Dashboard dialog along with the Display Text.
Pause Execution
Yes/No
Yes indicates that script execution will pause when the memo is reached. Select the Continue button to resume the Script execution.
Show Memo Dialog
Yes/No
Yes indicates that memo execution will open a dialog which presents the memo display and explanation texts.
Show Explanation in the Dashboard
Yes/No
Yes indicates that the explanation text will be displayed with the display text in the Dashboard.
 Open File
Open the specified external file using the windows file association. If you would like to pause script execution after opening the file, add a Memo action, described at “Memo”, after the Open File action.
 
Setting
Type
Notes
File name
Text
Enter the file path. See “Filename Information” for details. The file will be opened using the application associated with the file's extension in Windows. For example, temp.xlsx will be opened using Excel.
 Open Global Functions Set
Open a global function set.
 
Setting
Type
Notes
File name
Text
Enter the file path. See “Filename Information” for details.
Confirm Replacement
Yes/No
Yes indicates that if the specified set is already open, a dialog should be presented to confirm replacement of the existing set.
Show Dialog
Yes/No
When this setting is Yes, the RPL set dialog is shown when the action is executed. Otherwise, the set is opened into the model, but not shown.
 Open Objects
Open the specified objects’ dialogs.
 
Setting
Type
Notes
Objects
Object Selection
Choose the objects to open.
 Open SCT
Open a System Control Table (SCT) with the specified filename.
 
Setting
Type
Notes
File Name
Text
Enter the file path. See “Filename Information” for details.
 Open Slots
Open the specified slots.
 
Setting
Type
Notes
Slots
Slot Selection
Choose the slots using the selector.
 Remove RPL Set
Remove a selected RPL set from the model. An RBS Ruleset or Optimization Goal set is unloaded and closed, a Global Function Set is closed, or the Initialization Rules Set is cleared.
Note:  If you have any of these sets saved in the model file and you remove them using this action, any changes will be lost! This action should only be used if you have the set saved to a file and wish to remove it from the model and reopen it from the file. Use with caution!
 
Setting
Type
Notes
Set
Single Selection
Choose the desired RPL set.
Confirm Removal
Yes/No
Yes indicates that a dialog should be presented to confirm removal of the set.
 Reorder RPL Set
Reorder the items (rules, goals, statements) in a RPL set according to priority or index defined on the specified table slot.
 
Setting
Type
Notes
Set
Single Selection
Choose the desired RPL set.
Order Slot
Single Slot Selection
Choose the table slot which specifies the new RPL set ordering. See “RPL Reorder Set Action” for details.
 Replace Initialization Rules Set From File
Replace the existing Initialization Rules Set from a file. Any changes made to the Initialization Rules in the model will be lost. Use with caution!
 
Setting
Type
Notes
File name
Text
Enter the file path. See “Filename Information” for details.
Confirm Replacement
Yes/No
Yes indicates that a dialog should be presented to confirm replacement of the existing Initialization Rules Set.
Show Dialog
Yes/No
When this setting is Yes, the RPL set dialog is shown when the action is executed. Otherwise, the set is replaced in the model, but not shown.
 Save Model
Save the model to a file.
 
Setting
Type
Notes
File Name
Text
Enter the file path. See “Filename Information” for details.
Include Output Values
Yes/No
Yes indicates output values will be saved.
Output Values Precision
Integer
Indicates the precision to use for output values.
Confirm Overwrite
Yes/No
Yes requires interactive confirmation when saving the model to a preexisting file.
 Set Account Method
Set the selected method in one of an account’s method categories.
 
Setting
Type
Notes
Account Name
Text
Choose the account using the selector
Category
Text
Choose the category on the account
Method
Text
Choose the desired method
 Set Accounting Period
Set the time range of the accounting system (i.e., the Begin Accounting Period and End Accounting Period dates).
 
Setting
Type
Notes
Start Date
Datetime
End Date
Datetime
 Set Controller
Set the current controller.
 
Setting
Type
Notes
Controller
Selection
Choose the controller from the list
 Set Dataset File
Set the DSS file for a specified DSS Dataset or the Excel workbook for a specified Excel Dataset.
 
Setting
Type
Notes
Dataset
Text
Enter or choose the name of a DSS Dataset or an Excel Dataset defined in the Dataset Manager.
File Name
Text
Enter or choose the DSS file or Excel workbook.
Allow File Editing
Selection
Yes means the file can be entered or chosen in the Dashboard. No means that the file cannot be changed in the Dashboard.
 Set Excel Dataset Run Name
For the specified Database DMI Excel Dataset, set the run name type and/or specify a new single run name.
 
Setting
Type
Notes
Excel Dataset
Text
Enter or choose the name of an Excel Dataset defined in the Dataset Manager. See “Excel Datasets” in Data Management Interface (DMI) for details on Excel Datasets.
Run Name Type
Selection
Choose one of the available Run Name Types either:
Single Run Name
Run with MRM Number (i.e. Run0, Run1, ...)
Trace with MRM Trace Number (i.e. Trace1, Trace2,...)
Single Run Name
Text
This setting is shown when the above setting is set to Single Run Name. Enter a new Single Run Name or choose one from the list; see “Run Name Type” in Data Management Interface (DMI) for details. In the Script Dashboard you can enter a new Single Run Name or choose one from the same list.
 Set Init. Rules Exec. Flag
Set the Execute Initialization Rules run control flag. This flags controls whether or not the initialization rules are executed as part of the run. The flag is independent for each major controller, Simulation, Rulebased Simulation and Optimization. For more information, see “Can I disable the Initialization Rules?” in RiverWare Policy Language (RPL).
 
Setting
Type
Notes
Sim and RBS
Yes/No
Yes = execute initialization rules before each Simulation or Rulebased Simulation run, including those controllers that include Accounting.
Optimization
Yes/No
Yes = execute initialization rules before an Optimization run.
 Set Method
Set the selected method in the specified category for a set of objects.
 
Setting
Type
Notes
Object Name
Text
Choose one or more the objects using the selector
Category
Text
Choose the category on the object. The list shown is for the first object.
Method
Text
Choose the desired method. If the category or method is not possible on the object, an error will be issued.
 Set MRM Descriptor
In a given MRM configuration, set the specified keyword, value pair MRM Descriptor. The descriptors are shown on the Description tab of the MRM configuration. See “Description” in Solution Approaches for details.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller
Keyword
Text
Specify the Keyword. If the Keyword does not exist in the configuration, a new one is created.
Value
Text
Specify the desired Value to use with the Keyword.
 Set MRM Ruleset
In a given MRM configuration, set a new file path to a ruleset.The ruleset is shown on the Policy tab of the MRM configuration. See “Policy” in Solution Approaches for details.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller
Ruleset
Integer
Specify which of the rulesets you wish to change. The default is the first ruleset, 1.
File Name
Text
Enter the file path. See “Filename Information” for details.
 Set MRM Run Range
Set the time range of the run (i.e. the Run Start and End dates) for the specified MRM configuration. The run range is shown on the Run Parameters tab of the MRM configuration. See “Concurrent Runs” in Solution Approaches for details.
 
Setting
Type
Notes
MRM Configuration
Text
Enter or choose the name of an MRM configuration defined in the MRM Run Controller
Start Date
Datetime
End Date
Datetime
Allow Start Date Editing
Yes/No
Yes indicates that users should be allowed to override the start date in the Dashboard.
Allow End Date Editing
Yes/No
Yes indicates that users should be allowed to override the end date in the Dashboard.
 Set Run Range
Set the time range of the run (i.e., the Run Start and End dates).
 
Setting
Type
Notes
Start Date
Datetime
End Date
Datetime
Allow Start Date Editing
Yes/No
Yes indicates that users should be allowed to override the start date in the Dashboard.
Allow End Date Editing
Yes/No
Yes indicates that users should be allowed to override the end date in the Dashboard.
 Set Run Timestep
Set the run timestep size. This action is analogous to changing the run control timestep size. The settings in the action are analogous to the options presented in the Synchronize Timestep Change dialog; see “Synchronize From Run Control” in User Interface for details.
 
Setting
Type
Notes
Timestep
Selection
Choose from 5 Minute, 15 Minute, 1 Hour, 6 Hour, 12 Hour, 1 Day, 1 Month, or 1 Year.
Synchronize Objects with New Timestep
Yes/No
Should objects be synchronized to the new timestep?
Exclude Slots with Timesteps Different Than Original Run
Yes/No
Should slots with a timestep that is different than the original run be synchronized with the new timestep?
Aggregate Input Data to the New Timestep
Yes/No
When changing to a larger timestep (1 Month or 1 Year), should Input values be aggregated?
Aggregate NaN Handling
Selection
If aggregating, how should NaN and Output values in input slots be handled? See “Synchronize From Run Control” in User Interface for details on aggregation.
 Set Scalar Slot Value
Set one or more Scalar Slot values.
 
Setting
Type
Notes
Slots
Slot Selection
Choose the scalar slots using the selector
Set by
Value/Function
This setting indicates how you wish to set the slot, either by specifying values or by a global RPL function. When set to “Value”, the “Value” setting and Allow editing setting, below, are shown. When set to “Function”, the RPL Global Function setting is shown.
Note:  Only numeric or datetime slots can be set via the “Function” option.
Value
Value
If the “Value” option is selected in the “Set by” setting, specify the value to set at each timestep specified. This value can remain or be set to NaN.
RPL Global Function
Single Selection
If the “Function” option is selected in the “Set by” setting, use the RPL function chooser to select the function.
Allow Editing
Selection
No indicates that the value can not be changed in the Dashboard, Yes: Editor indicates that it can be changed using a line editor; Yes: Radio Buttons indicate that a set of radio buttons should be presented in the Dashboard to override the value; and Yes: Slider indicates that a slider should be presented to allow changes to the value. See “Configuring User Control on the Script Dashboard” for details.
Minimum Edit Value
Numeric
(slot value)
Specify the minimum value that is allowed in the Dashboard (applies to Slider only).
Maximum Edit Value
Numeric
(slot value)
Specify the maximum value that is allowed in the Dashboard (applies to Slider only)
Encoding Table Slot Name
Slot Selection
The table slot row labels and values establish a textual encoding of values. Applies only to Radio Button display. See “Configuring User Control on the Script Dashboard” for details.
Show Current Value
Yes/No
When Allow Editing is Yes, then this setting allows you to show the current value for the scalar slot on the Dashboard. This only works when one scalar slot is specified.
RPL Global Function
RPL function selector
When using the “Set by:” “Function” mode, specify the Global Function to use. Currently, this function must return a Numeric value or a Datetime. The function is passed the SLOT as an argument. Use these as desired. See “Setting Slot Values using a Global Function” for details.
 Set Series Slot Flags
Set the specified flag (input or output) on a set of series slots within the specified time range.
 
Setting
Type
Notes
Slots
Slot Selection
Enter or choose one or more series slots. The flags in these slots will be set to the specified value.
Column
Value or Text
For multi-column series slots, specify the column as either the column number (zero based) or column heading. If not specified, the first column is used.
Start Date
Datetime
The first timestep for which you wish to set the flag. See “Datetime Information” for details.
End Date
Datetime
The last timestep for which you wish to set the flag.See “Datetime Information” for details.
Flag
Selection
The flag to set on each value in the range.
 Set Series Slot Values
Set Series Slot values within a time range.
Note:  This action does not support the setting of Text Series Slots.
 
Setting
Type
Notes
Slots
Slot Selection
Choose the series slot using the selector
Set by
Value/Function
This setting indicates how you wish to set the slot, either by specifying values or by a global RPL function. When set to “Value”, the “Value” setting and editing setting, below, are shown. When set to “Function”, the RPL Global Function setting is shown.
Note:  Only numeric or datetime slots can be set via the “Function” option.
Column
Value or Text
For multi-column series slots, specify the column as either the column number (zero based) or column heading. If not specified, the first column is used.
Value
Value
If the “Value” option is selected in the “Set by” setting, specify the value to set at each timestep specified. This value can remain or be set to NaN.
RPL Global Function
Single Selection
If the “Function” option is selected in the “Set by” setting, use the RPL function chooser to select the function.
Start Date
Datetime
End Date
Datetime
Allow Editing
Selection
No indicates that the value can not be changed in the Dashboard, Yes: Editor indicates that it can be changed using a line editor; Yes: Radio Buttons indicate that a set of radio buttons should be presented in the Dashboard to override the value; and Yes: Slider indicates that a slider should be presented to allow changes to the value.
Minimum Edit Value
Numeric (slot value)
Specify the minimum value that is allowed in the Dashboard (applies to Slider only).
Maximum Edit Value
Numeric (slot value)
Specify the maximum value that is allowed in the Dashboard (applies to Slider only).
Encoding Table Slot Name
Slot Selection
The table slot row labels and values establish a textual encoding of values. Applies to Radio Buttons only. See “Configuring User Control on the Script Dashboard” for details.
RPL Global Function Name
RPL function selector
When using the “Function” mode, specify the Global Function to use. Currently, this function must return a Numeric or a Datetime depending on the slot’s unit type. The function is passed the SLOT and DATETIME as arguments. Use these as desired. See “Setting Slot Values using a Global Function” for details.
 Set Table Slot Value
Set a single Table Slot value at the specified row and column.
 
Setting
Type
Notes
Slots
Slot Selection
Choose the table slot using the selector
Row
Text
Specify the row as either the row number (zero based) or the row heading
Column
Text
Specify the column as either the column number (zero based) or column heading
Set by
Value/Function
This setting indicates how you wish to set the slot, either by specifying values or by a global RPL function. When set to “Value”, the “Value” setting and editing setting, below, are shown. When set to “Function”, the RPL Global Function setting isshown.
Note:  Only numeric and datetime slots can be set via the “Function” option.
Value
Value
If the “Value” option is selected in the “Set by” setting, specify the value to set at each timestep specified. This value can remain or be set to NaN.
RPL Global Function
Single Selection
If the “Function” option is selected in the “Set by” setting, use the RPL function chooser to select the function.
Allow Editing
Selection
No indicates that the value can not be changed in the Dashboard, Yes: Editor indicates that it can be changed using a line editor; Yes: Radio Buttons indicate that a set of radio buttons should be presented in the Dashboard to override the value; and Yes: Slider indicates that a slider should be presented to allow changes to the value.
Minimum Edit Value
Numeric
(slot value)
Specify the minimum value that is allowed in the Dashboard (applies to Slider only).
Maximum Edit Value
Numeric
(slot value)
Specify the maximum value that is allowed in the Dashboard (applies to Slider only)
Encoding Table Slot Name
Slot Selection
The table slot row labels and values establish a textual encoding of values. Applies to Radio Buttons only. See “Configuring User Control on the Script Dashboard” for details.
RPL Global Function Name
RPL function selector
When using the “Function” mode, specify the Global Function to use. Currently, this function must return a Numeric or a Datetime depending on the slot’s unit type. The function is passed the SLOT, row NUMERIC, and column NUMERIC, as arguments. Use these as desired. See “Setting Slot Values using a Global Function” for details.
 Synchronize Objects
Set the time range for the specified objects.
 
Setting
Type
Notes
Objects to Synchronize
Object Selection
Use the selector to choose the desired objects.
Exclude Slots with Non-run Timestep
Yes/No
Yes indicates that slots with different timesteps will be excluded from the synchronize action.
Start Date
Datetime
End Date
Datetime
 Synchronize Slots
Set the time range for the specified slots.
 
Setting
Type
Notes
Slots to Synchronize
Slot Selection
Use the selector to choose the desired slots.
Start Date
Datetime
End Date
Datetime
Revised: 11/11/2019