Item Type | Account Method Table | |
---|---|---|
Description | Displays a table with an account’s method categories and the selected method in each category. Note: These are account level methods, not object level methods. | |
Setting | Type | Notes |
Selection | Single Selection | The account whose methods should be displayed |
Title | Single line text | The text to appear as the table title |
Show Only Non-default Methods | Yes/No | If yes, only categories with a non-default method selected are included in the table. |
Sample |
Item Type | Account Section | |
---|---|---|
Description | Displays a section describing an account on the workspace. The title is the name of the account. Sub-sections can be added to an account section. | |
Setting | Type | Notes |
Account Name | Single Selection | The account associated with this section. |
Include Account Type | Yes/No | If Yes, the account type is included in the section title. |
Show Description | Yes/No | Not applicable. |
Sample |
Item Type | Account Table | |
---|---|---|
Description | Presents a table with a list of accounts (often those for a single simulation object) and optional columns for several account attributes including type, water type, water owner, and priority date | |
Setting | Type | Notes |
Selection | Multiple Selection | The accounts to include in the table |
Title | Single line text | The text to appear as the table title |
Include Object Name | Yes/No | |
Include Account Name | Yes/No | |
Include Water Owner | Yes/No | |
Include Water Type | Yes/No | |
Include Priority Date | Yes/No | |
Sample |
Item Type | Accounting System Settings | |
---|---|---|
Description | Lists the information on the accounting system including range, accrual date, water types, owners, etc. This is the information shown in the Accounting, then Account System Configuration dialog. | |
Setting | Type | Notes |
Include Account Water Owners | Yes/No | If yes, show a table of all user-defined Water Owners. |
Include Account Water Types | Yes/No | If yes, show a table of all user-defined Water Types. |
Include Supply Release Types | Yes/No | If yes, show a table of all user-defined supply Release Types. |
Include Supply Destinations | Yes/No | If yes, show a table of all user-defined supply Destination Types. |
Sample |
Item Type | Chart | |
---|---|---|
Description | Displays an image of an existing Chart output device. Use the configured timestep or override with an optional setting. | |
Setting | Type | Notes |
Chart Name | Single Selection | The existing chart device to include in the report |
Title | Single line text | The text to appear above the chart. |
Date/Time | Date/Time | The timestep to be used for series data within the chart. If left blank, the timestep defined on the chart is used. If specified, that date is used. See Date/Time Specification for additional information. |
Chart Width (pixels) | Integer | The width of the chart in pixels. The default is 500. |
Chart Height (pixels) | Integer | The height of the chart in pixels. The default is 500. |
Sample |
Item Type | Image | |
---|---|---|
Description | Shows an Image imported from a file. An optional caption setting is provided. | |
Setting | Type | Notes |
Image Name | Single-line text | The image name is used only to identify the image within the Report Layout tree. It is initially taken from the imported image’s file name. |
Caption | Multi-line text | A string of text to appear below the image. For more information on images, see the text below the table. |
Item Type | Link Table | |
---|---|---|
Description | Presents a table of the physical links to slots on the specified object, optionally limited to links to the slots on a second specified object. | |
Setting | Type | Notes |
Title | Single line text | The text to appear as the table title |
Object Name 1 | Object Selection | |
Object Name 2 | Object Selection | If specified, only the links between slots on Object 1 and Object 2. If not specified, any links from slots on Object 1 will be shown. |
Sample |
Item Type | Method Table | |
---|---|---|
Description | Displays a table of the method categories and the selected method in each category. When accounting is enabled, this table includes Object Level Accounting Methods. | |
Setting | Type | Notes |
Object Name | Single Selection | |
Title | Single line text | If present, will appear as the title of the table. |
Show Only Non-default Methods | Yes/No | |
Sample |
Item Type | Model Information | |
---|---|---|
Description | Lists the information contained in the Model Info dialog (accessed from the workspace using File, then Model Info), including the model’s save history and the specified comments. | |
Setting | Type | Notes |
Include File Save History | Yes/No | |
Include File Comment | Yes/No | |
Sample |
Item Type | Object Section | |
---|---|---|
Description | Creates a section for a workspace object, whose title is the name of that object and whose contents are controlled by the items in the section. | |
Setting | Type | Notes |
Object Name | Single Selection | |
Include Object Type | Yes/No | |
Show Description | Yes/No | Optionally include the description shown on the Description tab in the Open Object dialog. |
Sample |
Item Type | Output Canvas | |
---|---|---|
Description | Displays an image of an existing Output Canvas device. Use the configured timestep or override with an optional setting. See Output Canvas for additional information. | |
Setting | Type | Notes |
Output Canvas Name | Single Selection | The existing Output Canvas device to include in the report |
Title | Single line text | The text to appear above the canvas image. |
Date/Time | Date/Time | The timestep to be used for series data within the output canvas. If left blank, the timestep defined on the canvas is used. If specified, that date is used. See Date/Time Specification for additional information. |
Max Width (pixels) | Integer | The maximum width of the canvas in pixels. The default is 10000. The image is the natural size or smaller and the aspect ratio from the original canvas is maintained. |
Max Height (pixels) | Integer | The maximum height of the canvas in pixels. The default is 10000. The image is the natural size or smaller and the aspect ratio from the original canvas is maintained. |
Sample |
Item Type | Periodic Slot Table | |
---|---|---|
Description | Shows a table where the rows represent the time intervals of a periodic slot and the columns represent the columns in one or more periodic slots. These are used to display periodic slots that have only one column. Note: An error is generated if periodic slots having different overall periods are included. However, different time interval configurations can be represented within a single Periodic Slot Table. This includes mixes of regular interval and irregular interval configurations, and different specific interval start times. | |
Setting | Type | Notes |
Title | Single line text | If present, will appear as the title of the table. |
Column Slots | Sortable Slot Selection | See Lists of Items for details on selecting lists of items, |
Sample |
Item Type | Plot Page | |
---|---|---|
Description | Displays an image of an existing plot page output device. Use the Plot Page’s timesteps or override with an optional setting. | |
Setting | Type | Notes |
Plot Page Name | Single Selection | |
Title | Single line text | If present, will appear as the title of the plot page. |
Width (pixels) | Integer | |
Height (pixels) | Integer | |
Start Date | Date/Time | Specify the date/times to use in the report, if desired. This will override the Plot Page dates when specified. See Date/Time Specification for details. |
End Date | Date/Time | |
Sample |
Item Type | RPL Group | |
---|---|---|
Description | Displays a section for a single policy or utility group in a RPL set. | |
Setting | Type | Notes |
Set | Single Selection | These items might generate output for a RPL Report Group, and that group might include references to workspace objects, slots, or subbasins, so these items include format settings that apply to slots, objects, and subbasins. For example, each includes the “Slot: Include Object Name” setting which is used when generating output for a RPL Report Group containing a slot. See Blocks and Groups in RiverWare Policy Language (RPL) for details on groups. See RPL Printing and Formatting in RiverWare Policy Language (RPL) for details on the RPL selector. |
Group | Single Selection | |
Show Execution Properties | Yes/No | Show the index or priority range of the group (where applicable) and whether the group is enabled or disabled. |
Show Descriptions | Yes/No | Include the Descriptions entered on each RPL Editor dialog. See Descriptions in RiverWare Policy Language (RPL) for details. |
Show Notes | Yes/No | Include the Notes entered on each RPL Editor dialog. See Notes in RiverWare Policy Language (RPL) for details. |
Show RPL Comments | Yes/No | Include Comments that are inline in the RPL Expression. See Comments in RiverWare Policy Language (RPL) for details. |
List Rules in Order of Execution | Yes/No | For Policy Groups in RBS Rulesets, Initialization Rules Sets, and Iterative MRM Rules Sets, when set to Yes, the rules are displayed based on the Agenda Order. (See Show Advanced Properties in RiverWare Policy Language (RPL) for details on the Agenda Order.) When set to No, rules are displayed in the order they are shown in the RPL Set Editor. For Report Groups, Optimization Goal Sets, Accounting Methods and functions, this setting has no effect. These items are always displayed in the same order as in the RPL Set Editor. |
Sample |
Item Type | RPL Rule/Goal | |
---|---|---|
Description | Displays a section for a single RPL item (Rule/Goal/Accounting Method/Init Rule). | |
Setting | Type | Notes |
Set | Single Selection | |
Rule / Goal / Method / Init Rule | Single Selection | The Setting name depends on the type of set selected. |
Show Execution Properties | Yes/No | Show the index, priority, and flag where applicable and whether the item is enabled or disabled. |
Show Description | Yes/No | Include the Descriptions entered on each RPL Editor dialog. See Descriptions in RiverWare Policy Language (RPL) for details. |
Show Notes | Yes/No | Include the Notes entered on each RPL Editor dialog. See Notes in RiverWare Policy Language (RPL) for details. |
Show RPL Comments | Yes/No | Include Comments that are inline in the RPL Expression. See Comments in RiverWare Policy Language (RPL) for details. |
Sample |
Item Type | RPL Set | |
---|---|---|
Description | Displays a section for each policy and utility group in a RPL set. | |
Setting | Type | Notes |
Set | Single Selection | These items might generate output for a RPL Report Group, and that group might include references to workspace objects, slots, or subbasins, so these items include format settings that apply to slots, objects, and subbasins. For example, each includes the “Slot: Include Object Name” setting which is used when generating output for a RPL Report Group containing a slot. See Blocks and Groups in RiverWare Policy Language (RPL) for details on groups. See RPL Printing and Formatting in RiverWare Policy Language (RPL) for details on the RPL selector. |
Show Policy Groups | Yes/No | |
Show Utility Groups | Yes/No | |
Show Global Groups | Yes/No | |
Show Execution Properties | Yes/No | For each item in the set, show the index, priority, and flag where applicable and whether the item is enabled or disabled. |
Show Descriptions | Yes/No | Include the Descriptions entered on each RPL Editor dialog. See Descriptions in RiverWare Policy Language (RPL) for details. |
Show Notes | Yes/No | Include the Notes entered on each RPL Editor dialog. See Notes in RiverWare Policy Language (RPL) for details. |
Show RPL Comments | Yes/No | Include Comments that are inline in the RPL Expression. See Comments in RiverWare Policy Language (RPL) for details. |
List Rules in Order of Execution | Yes/No | For RBS Rulesets, Initialization Rules Sets, and Iterative MRM Rules Sets, when set to Yes, the rules are displayed based on the Agenda Order. (See Show Advanced Properties in RiverWare Policy Language (RPL) for details on the Agenda Order.) When set to No, rules are displayed in the order they are shown in the RPL Set Editor. For Report Groups, Optimization Goal Sets, Accounting Methods and functions, this setting has no effect. These items are always displayed in the same order as in the RPL Set Editor. |
Item Type | RPL Statement | |
---|---|---|
Description | Shows a single top-level RPL Statement within a RPL Block (a Rule, Goal, User-Defined Accounting Method or Initialization Rule). | |
Setting | Type | Notes |
Set | Single Selection | |
Rule / Goal / Method / Init Rule | Single Selection | The Setting name depends on the type of set selected. |
Statement | Single Selection | The RPL Statement within the selected RPL Block. Statement items are presented in a menu in the form of the statement number (1) and the Statement name. Note: The default statement name is the statement type (Assignment, Print, etc.). You can rename statements as follows. From the main RPL Set editor, Select View, then Show Statements. Locate the desired statement in the tree-view. Right-click the statement and select Rename. Enter a new name. |
Title | Text | Optional title text placed above the RPL Statement. The line editor includes a Set to Rule and Statement Name button, which recomputes the title from the RPL Block and Statement names. |
Show RPL Comments | Yes/No | Include comments that are inline in the RPL Expression. |
Sample |
Item Type | Run Control | |
---|---|---|
Description | Shows the information contained in the single run control dialog, including the controller, start and end dates, and timestep size. | |
Setting | Type | Notes |
N/A | ||
Sample |
Item Type | Run History | |
---|---|---|
Description | Shows status information about the last run. | |
Setting | Type | Notes |
Include RiverWare Version | Yes/No | Show the RiverWare version used for the last run. |
Include User | Yes/No | Show the user name for the user that made for the last run. |
Include Controller | Yes/No | Show the RiverWare controller used for the last run. |
Include Run Start Time | Yes/No | Display the time at which the last run was started. |
Include Run Duration | Yes/No | Display the duration of the last run. |
Include Run Status | Yes/No | Show the status of the last run including Finished, Aborted, Stopped, etc. |
Sample |
Item Type | Scalar Slot Grid | |
---|---|---|
Description | Presents a table showing a grid of scalar slot values. The rows of the table represent objects while the columns represent one or more named scalar slots. | |
Setting | Type | Notes |
Title | Single line text | If present, will appear as the title of the table. |
Row Objects | Sortable Object List | See Lists of Items for details on selecting lists of items. |
Column Slots | Slot Name List | See Lists of Items for details on selecting lists of items. |
Sample |
Item Type | Section | |
---|---|---|
Description | Presents a titled section whose contents are controlled by the items in the section. | |
Setting | Type | Notes |
Title | Single line text | The text used as the section name. |
Sample |
Item Type | Series Slot Notes Summary | |
---|---|---|
Description | Presents a table with all Series Slot Notes in the model as they are shown in the Note Manager (see Note Manager in User Interface). All note instances in the model are included with the exception that the table reflects the current setting in the Note Manager for whether or not to show notes instances on snapshot slots. The ordering and sorting of the columns is based on the current ordering and sorting in the Note Manager. | |
Setting | Type | Notes |
Title | Single line text | The text used as the title for the table |
Sample |
Item Type | Slot | |
---|---|---|
Description | Shows a slot’s name, description, and values. For, table, periodic and scalar slots, the values are shown. For series slots, a plot of the time series is shown. For Expression Slots, the RPL expression is shown along with a plot (series) or value (scalar) | |
Setting | Type | Notes |
Slot Name | Single Selection | |
Include Object Name | Yes/No | |
Include Account Name | Yes/No | |
Include Slot Type | Yes/No | |
Maximum Columns Per Table | Integer | If positive, values may be displayed in multiple tables as needed. |
Plot Width (pixels) | Integer | Applies to SeriesSlots whose values are plotted. |
Plot Height (pixels) | Integer | Applies to SeriesSlots whose values are plotted. |
Add PE/Storage Column | Yes/No | For certain table slots like the reservoir’s Elevation Area Table, a column of storage values corresponding to the elevations (using the Elevation Volume Table) are shown. Select No to not show this Storage column. |
Start Date | Date/Time | Specify the date/times to use in the plot of series data, if desired. This will override the default dates when specified. See Date/Time Specification for details. |
End Date | Date/Time | |
Show Description | Yes/No | Include the description entered on the Open Slot dialog. |
Show RPL Comments | Yes/No | For Expression Slots, show the RPL inline comments. |
Samples |
Item Type | Slot Value Table | |
---|---|---|
Description | Presents a table showing the name and a single value for one or more selected slots. Each row of the table is a slot. Columns include the Slot, Object (optional), Account (optional), Value, and Units. | |
Setting | Type | Notes |
Selection | Multiple Selection | |
Title | Single line text | If present, will appear as the title of the table. |
Include Object Name | Yes/No | |
Include Account Name | Yes/No | |
Sample |
Item Type | Subbasin | |
---|---|---|
Description | Shows a table of the members of a subbasin. | |
Setting | Type | Notes |
Subbasin | Single Selection | |
Sample |
Item Type | Supply Table | |
---|---|---|
Description | Presents a table of supplies and optional columns for supply attributes including type, release type, and destination. | |
Setting | Type | Notes |
Selection | Multiple Selection | The Supplies to include in the table |
Title | Single line text | The text to appear as the table title |
Include Supply Type | Yes/No | Show whether the supply is an Inflow/Outflow, Diversion/Return Flow, or Transfer supply |
Include Release Type | Yes/No | |
Include Destination | Yes/No | |
Sample |
Item Type | Table of Contents | |
---|---|---|
Description | Lists the sections in the report, with hyperlinks to their locations. | |
Setting | Type | Notes |
Title | Single line text | |
Sample |
Item Type | Tabular Series Slot Report | |
---|---|---|
Description | Displays an existing Tabular Series Slot Report output device in either HTML or text format. The title defined within the Tabular Series Slot Report is extracted from the report and presented as a report item title text within the generated Model Report. Use the configured timesteps or override with an optional setting. | |
Setting | Type | Notes |
Tabular Series Slot Report Name | Single Selection | The existing tabular series slot report device to include in the report |
Tabular Series Slot Report Format | HTML/Text | Tabular Series Slot Reports can be generated as an HTML table or as a Text table. |
Start Date | Date/Time | Specify the date/times to use in the report, if desired. This will override the Tabular Series Slot Report dates. See Date/Time Specification for details. |
End Date | Date/Time | |
Sample |
Item Type | Text | |
---|---|---|
Description | Prints user defined text. The text can be Plain Text or Rich Text which allows formatting. | |
Setting | Type | Notes |
Text | Multi-line text | Select More to edit the text in a dialog. |
Type | Rich or Plain | Specify whether the text is Plain Text (non-formatted letters and numbers) or Rich Text (formatted with fonts, colors, size, bullets etc). See Text Considerations for details on Rich Text. |