The Extract Editor is used to specify the data sources for required model inputs and their associated pathnames in the forecast.dss file.    

Accessing the Extract Editor

To open the Extract Editor, go to the Setup tab., open the Models menu, and select Edit Extract.

The Extract Editor is comprised of three sections: Extract Groups, Required Input, and Extract Linking.

Extract Groups

The Extract Groups section lists all extract groups defined for the watershed. From this box, you can:

  • Create, delete, rename, or duplicate an extract group
  • Set the groups to run by default
  • Change the execution order of groups
  • Apply color coding to groups set to run by default

Extract groups execute in the order they appear in the Extract Groups box. If multiple extract groups map data to the same record in the forecast.dss file, the last group to run will overwrite any previous data for that record.

Extract Groups Box

For detailed instructions, see Setting Up an Extract Group.

Required Input

This section lists all required time series inputs for each model alternative that must to be linked to a data source. 

The table includes the following information:

  • Index – A unique number assigned to each record (used only for filtering and organization).
  • Model – The name of the software application requiring the data.
  • Alternative – The specific model alternative requiring the data.
  • Location – The location associated with the input.
  • Parameter – The data type (e.g., flow, stage).
  • Type – The data type (time series or gridded).
  • Destination – The pathname the model is expecting within the forecast.dss file.

These columns are not shown by default. To see them, you must customize the table view - see the Table View Options section below for instructions.

Extract Linking

This section allows you to map source data to the required input records for each Extract Group.

Extract Linking Section of the Extract Editor Dialog

Each entry includes:

  • Index – A unique number assigned to each record (used only for filtering and organization).
  • From <data source> – The pathname of the source record.
  • Model – The name of the software application requiring the data.
  • Alternative – The specific model alternative requiring the data.
  • Location – The location associated with the input.
  • Parameter – The data type (e.g., flow, stage).
  • To forecast.dss – The destination pathname that will be written to the forecast.dss file.

If you edit the pathname in the Extract Linking Section, you must also change the Model Linking for that edited data. 

These columns are not shown by default. To see them, you must customize the table view - see the Table View Options section below for instructions.

Table View Options

You can customize the table display in both the Required Input and Extract Linking sections.

Pathname Filters

To filter records:

  • Click the magnifying glass in the upper-right corner of the table, or

  • Click the Filter List button below the table.

The Pathname Filters for Extract dialog provides slightly different filtering options based on whether you're filtering the Required Input or Extract Linking section.

Column Text Filters

You can filter the records to show only those that contain a specific word or phrase. Use asterisks in the Filter For box to filter by partial matches (e.g., starts with, ends with, or contains).

You can filter by:

  • Index
  • Model
  • Alternative
  • Location
  • Parameter
  • Type
  • Destination
  • Any Column

To apply multiple filters, click the + button to add additional rows to the filter list. To remove all filters at once, click the Clear Text Filters button.

Display Columns

Use the Display Columns settings to choose which columns to view in each table.

Hide Duplicate Destinations

Select Hide Duplicate Destinations to condense identical destination records into one row. For example, a time series record may be linked linked to observed data in both the HEC-HMS model alternative and the HEC-ResSim model alternative.

Hide Assigned Destinations

Select Hide Assigned Destinations to hide input records that are already linked (only available in the Required Input section).

Color Coding

You can use background and text colors to highlight records:

  • In Required Input, color-code based on whether a destination record is linked to a source.
  • In Extract Linking, color-code based on missing source records, unused records, or duplicates.

Additional Resources

Refer to this guide to learn more about setting up Extract Lists for your HEC-RTS watershed.