Setting | Type | Notes |
---|---|---|
Which Ensemble Data Set | Selection | Indicates how the ensemble data set will be specified. Select either “Most Recently Opened” or “Specified by Name”. |
Ensemble Data Set Name | Text | If the above selection is 'Specified by Name', then this setting is used to specify the name of the data set. |
Analysis Type | Selection | Specify the statistic to compute for the selected ensemble data. Options are: Max, Mean, Median, Min, Percentile, or Sum |
Percentage (0% - 100%) | Number (as a percent) | When Percentile is the Analysis Type, this setting is the percentile. That is, for the trace values with a given slot and date, the percentile the lowest value that is greater than or equal to that of the values. |
How to Filter Slots | Selection | How to filter the analysis data by slot. Options in include All Slots and Include Only Specific Slots |
Slots To Include | Slot Selection | When “Include Only Specific Slots” is selected, this setting defines the slots. |
How to Filter Dates | Selection | How to filter the analysis data by date. Options include All Dates, Include Only Dates In A Specific Range |
Start Date | Datetime | When “Dates in a Specific Range” is selected, this setting defines the start date. See Datetime Information for details. |
End Date | Datetime | When “Dates in a Specific Range” is selected, this setting defines the end date.See Datetime Information for details. |
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. |
Output Slot Tag | Text | This text string is added to the output slot name, see below. |
Output Slot Column | Integer | If the output slot is an Agg Series slot and the output slot column value is other than zero, the results are written to that column of the output slot. |
Setting | Type | Notes |
---|---|---|
DMI Name | Text | Enter the DMI name or choose the DMI using the menu. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | Enter or choose one or more scalar slots for which you wish to clear the values. |
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 |
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 |
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. |
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. |
Setting | Type | Notes |
---|---|---|
RDF File Name | Text | Enter the file path. See Filename Information for details. |
Ensemble Data Set Name | Text | The name to give to the open data set once it is created |
Setting | Type | Notes |
---|---|---|
None |
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. |
Setting | Type | Notes |
---|---|---|
Which Ensemble Data Set | Selection | Indicates how the ensemble data set will be specified. Select either “Most Recently Opened” or “Specified by Name”. |
Ensemble Data Set Name | Text | If the above selection is 'Specified by Name', then this setting is used to specify the name of the data set. |
Setting | Type | Notes |
---|---|---|
Slot 1 | Slot Selection | This is the slot at one end of the link. |
Slot 2 | Slot Selection | This is the slot at the other end of the link. |
Setting | Type | Notes |
---|---|---|
Divider Color | Color Chooser | Use the color chooser to select the background color for the divider. |
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. |
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. |
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. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | Choose the slots using the selector. |
Setting | Type | Notes |
---|---|---|
DMI Name | Text | Enter the DMI name or choose the DMI using the menu. |
Setting | Type | Notes |
---|---|---|
Configuration | Text | Enter the name of an MRM configuration you wish to run. |
Setting | Type | Notes |
---|---|---|
None |
Setting | Type | Notes |
---|---|---|
Script Name | Text | Type the script name or choose the desired single script from the script selector. |
Setting | Type | Notes |
---|---|---|
File Name | Text | Enter the file path to create or overwrite. See Filename Information for details. |
DMI Names | Text | Select one or more DMIs using the DMI Selector. |
Include Datasets and Name Maps | Yes/No | Select Yes to also export the Datasets and Name Maps referenced by Database DMI. Select No to export only the Database DMI and not the referenced Datasets and Name Maps. See Export in Data Management Interface (DMI) for more information |
Setting | Type | Notes |
---|---|---|
File Name | Text | Enter the file path to create or overwrite. See Filename Information for details. |
Objects | Object Selection | Choose the desired objects using the object selector. Note, exporting clusters is not supported within a script. |
Include Links | Yes/No | Yes indicates workspace links between slots will also be exported. |
Include Attributes | Yes/No | Yes indicates object attributes will be exported. |
Include Text Notes | Yes/No | Yes indicates series slot text notes will be exported. |
Include Storage Accounts | Yes/No | Yes indicates storage accounts on specified reservoir objects will be exported. |
Include Diversion Accounts | Yes/No | Yes indicates diversion accounts on the specified objects will be exported. |
Include Instream Flow Accounts | Yes/No | Yes indicates instream flow accounts on specified control points will be exported. |
Include Passthrough Accounts | Yes/No | Yes indicates passthrough accounts on specified objects will be exported. |
Include Supplies | Yes/No | Yes indicates supplies (accounting links) between accounts will be exported. |
Setting | Type | Notes |
---|---|---|
Device Name | Text | Enter or choose the name of a output device (plot, file, report, chart) |
Setting | Type | Notes |
---|---|---|
Scroll to DateTime | Datetime | See Datetime Information for details. |
Allow Editing | Selection | Yes indicates that users should be allowed to override the start date in the Dashboard. |
Setting | Type | Notes |
---|---|---|
File Name | Text | Enter the file path to the file containing the exported DMIs. See Filename Information for details. |
Resolve Conflicts | Selection | Select either “Import the DMI items, replacing those in the model” or “Import the DMI items with unique names”. These choices correspond to the Import conflicts with a unique name option described in Import in Data Management Interface (DMI). |
Setting | Type | Notes |
---|---|---|
File Name | Text | Enter the file path to the file containing the exported objects. See Filename Information for details. |
Import Attributes | Yes/No | Yes indicates object attributes will be imported. |
Import Text Notes | Yes/No | Yes indicates series slot text notes will be imported. |
Object Clusters | Selection | Specify how exported object clusters are imported. There are two choices “Import member objects and cluster configuration” and “Import cluster configuration only”. |
Import Location | Selection | Choose either “Use exported coordinates” or “Near object”. |
Near Object | Object Selection | When the Import Location setting above is “Near object”, select an object. The imported objects will be imported just to the right of the specified object. |
Setting | Type | Notes |
---|---|---|
Slot 1 | Slot Selection | The first slot to link. Only physical (non-accounting) series slots can be linked. |
Slot 2 | Slot Selection | The second slot to link. Only physical (non-accounting) series slots can be linked. |
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. |
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. |
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. |
Setting | Type | Notes |
---|---|---|
None |
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. |
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. |
Setting | Type | Notes |
---|---|---|
Objects | Object Selection | Choose the objects to open. |
Setting | Type | Notes |
---|---|---|
File Name | Text | Enter the file path. See Filename Information for details. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | Choose the slots using the selector. |
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. |
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. |
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. |
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. |
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 |
Setting | Type | Notes |
---|---|---|
Start Date | Datetime | See Datetime Information for details. |
End Date | Datetime | See Datetime Information for details. |
Setting | Type | Notes |
---|---|---|
Controller | Selection | Choose the controller from the list |
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. |
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. |
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. |
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. |
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. |
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. |
Setting | Type | Notes |
---|---|---|
MRM Configuration | Text | Enter or choose the name of an MRM configuration defined in the MRM Run Controller |
Start Date | Datetime | See Datetime Information for details. |
End Date | Datetime | See Datetime Information for details. |
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. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | Choose the periodic slot using the selector. |
Row | Text | Specify the row as either the row's zero-based integer index or the label for its interval (e.g., “Feb”). |
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 is shown. 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. |
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 | 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. |
Setting | Type | Notes |
---|---|---|
Start Date | Datetime | See Datetime Information for details. |
End Date | Datetime | See Datetime Information for details. |
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. |
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. |
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. |
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. |
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. |
Flag | Selection | The flag to set on each value in the range. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | Enter or choose one or more series slots with periodic input. Any other type of slot will issue an error when the script is run. |
Input Mode | Series/Periodic | Choose either series or periodic mode. |
Confirm Input Overwrite? | Yes/No | When switching from series mode to periodic mode, it is possible that the input values do not match the periodic values and the series would be overwritten by the periodic values. If this setting is Yes, a confirmation is posted (like in interactive mode) and you can choose to overwrite or skip. If No, the values will be overwritten. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | The series slots with periodic input whose periodic input value will be set. |
Row | Value or Text | The row of the table of periodic input whose value is to be set. Use either the row's zero-based integer index or the label for its interval (e.g., “Feb”). |
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. |
Value | Value | If the “Value” option is selected in the “Set by” setting, specify the value to set. This value can remain or be set to NaN. |
RPL Global Function | 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 row NUMERIC as arguments. Use these as desired. See Setting Slot Values Using a Global Function for details. |
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. |
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. |
Start Date | Datetime | See Datetime Information for details. |
End Date | Datetime | See Datetime Information for details. |
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. |
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. |
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 | 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. |
Setting | Type | Notes |
---|---|---|
Slots | Slot Selection | Choose the table slot or periodic slot using the selector. Although this action will set periodic slots, see also Set Periodic Slot Value. |
Row | Text | Specify the row as either the row number (zero based) or the row heading. For Periodic slots, use either the row's zero-based integer index or the label for its interval (e.g., “Feb”). |
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 is shown. 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. |
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 | 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. |
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 | See Datetime Information for details. |
End Date | Datetime | See Datetime Information for details. |
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. |
Setting | Type | Notes |
---|---|---|
Slots to Synchronize | Slot Selection | Use the selector to choose the desired slots. |
Start Date | Datetime | See Datetime Information for details. |
End Date | Datetime | See Datetime Information for details. |
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. |