KiWIS Extract Group
When a KiWIS extract group is selected, information displayed in the Extract Linking section is the data Type, KiWIS Url, and the User name and Password needed to access a WISKI database. The TS Group Id lists all the group ID's in a WISKI database. The TS Group Id can be used to filter WISKI records, which will increase the speed of the query process for large databases when accessing them through CWMS.
The Extract Linking table displays the following information when a KiWIS extract group has been selected:
- From KiWIS - source data pathnames that's data will fill the HEC-DSS record displayed in the To forecast.dss column
- Model - software application that is requesting the required input record
- Alternative - model alternative name that is requesting the input record
- Location - name of the model location object that is associated with the input record
- Parameter - parameter associated with the input record's data
- To forecast.dss - input record pathname that the model requires (the pathname that will be written to the forecast.dss file and used by a model during the forecast compute)
- Index - a number assigned to each required destination pathname when it is loaded into the Extract Editor (this number is used to keep the initial filtered list set, and there can be multiple indices for a single HEC-DSS pathname)
Most of the above information does not display by default in the Extract Linking table. You will need to set up the table view (see Extract Editor for more information on how to turn on/off the options shown above).
Creating a KiWIS Extract Group
A KiWIS extract group maps time series data from the WISKI database to the required model alternative's input time series records that will be stored in the forecast.dss file. You will need the KiWIS URL, a username, and a password to configure a KiWIS extract group.
To create a KiWIS extract group:
- From the CWMS CAVI main window, click on the Setup tab.
- From the Models menu, click Edit Extract and the Extract Editor will open.
- Click New Extract Group in the Extract Groups box.
- The New Extract Group dialog will open.
- In the Name box, enter a name for your KiWIS extract group.
- From the Type list, select Time Series.
- From the Source list, select KIWIS.
- Enter your user login into the User box and your password into the Password box. Both the username and password are case sensitive.
- From the KiWIS Url box, enter the URL for the WISKI database.
- The items in the DSS Storage Options box are only applicable to Oracle and HEC-DSS source files. No changes to these values are necessary when using KiWIS as your data source.
- By default, Run by Default is selected, which means the extract group will run automatically when a forecast is being computed. If you do not want this extract to run automatically, uncheck this box.
- Specify the Time Window to extract the data from the Start and End lists.
- Available options are: Extract Start, Start of Simulation, Forecast Time, End of Simulation.
- Offsets for the start and end times can also be included.
- Available options are: hours, minutes, or seconds.
- In the Offset box, you will enter the offset increment. This time window is relative to the forecast time window defined when you create a forecast.
- When you are finished, click OK. The New Extract Group dialog will close.
- The new extract group will display at the bottom of the Extract Groups list, and the information about the extract group will display.
Extract groups are run in the order they are displayed in the Extract Groups box. If you run more than one extract group during the extract process and there are records that are mapped in more than one of the selected extract groups, the last extract group mapping will replace all previous mappings.
Adding Required Input Data to Extract Groups
Once an extract group is defined, you can select what Required Input data you want to map to the selected source data. In this case the source data is the WISKI database. Detailed information is provided in Extract Groups.
Selecting KiWIS Source Records
When Required Input records are added to a KiWIS extract group, they display the name of the required input record under the From KiWIS column in the Extract Linking table. The From KiWIS record pathnames need to be replaced with WISKI database source time series records that will provide data to the To forecast.dss column of the Extract Linking table.
The TS Group Id list, in the Extract Linking section, provides a list of all the time series groups created in KiWIS. The TS Group Id is used in the Extract Editor to manage the size of a WISKI database request and speeds up the time required to populate the list of records when selecting KiWIS records for the extract.
To select a WISKI database time series record:
- Double-click the row in the From KiWIS column you would like to set the KiWIS time series record for.
- Click the ellipse that appears in the right section of the cell with the From KiWIS name.
- The KiWIS Time Series Record Chooser dialog will open.
- You can filter the KiWIS pathnames displayed in the table by using the Search By Parts Parameters at the top of the KiWIS Time Series Record Chooser.
- To select a KiWIS time series record, select the appropriate time series record row in the KiWIS Time Series Record Chooser dialog and click Set Pathnames.
- The WISKI database time series record you selected will display in the Extract Linking table in the row you original selected.
- Repeat steps 1-6 for as many records that you need to replace.
- Once all KiWIS time series records have been set in the Extract Linking table, close the KiWIS Time Series Record Chooser dialog.
Adhoc Records - Extract
Additional input data not listed in the Required Extract table may be required for a forecast compute. You can add additional time series records from the WISKI database using the Adhoc Record feature. An Adhoc record allows you to add WISKI database time series records to an HEC-DSS time series record in the forecast.dss file.
To add a WISKI Adhoc record:
- From the Extract Editor, click Add Extract Data Set. The Adhoc: KiWIS Time Series Record Chooser dialog will open.
- From the Search By Parts area, use the various filter lists to locate the desired WISKI database time series record.
- Select the pathname row for the record you wish to add and then click Set Pathname.
- Once you have selected all the pathnames for all the necessary time series records, close the Adhoc: KiWIS Time Series Record Chooser.
Renaming Destination Record Pathnames
Initially, the From KiWIS and To forecast.dss time series records will display the same pathname. You will need to change the time series record pathname displayed in the To forecast.dss column of the Extract Linking table to a conventional HEC-DSS pathname. You can either enter the pathname or select one through the KiWIS Time Series Record Chooser dialog.
To select an HEC-DSS pathname using the KiWIS Time Series Record Chooser:
- From the Extact Linking table, select the To forecast.dss record you would like to change.
- Click Browse To, and the KiWIS Time Series Record Chooser dialog will display.
- Click Open from the File menu. An Open HEC-DSS File browser will open.
- Browse to location of the HEC-DSS file you will be copying time series record to (forecast.dss), select the filename and click Open.
- The Open HEC-DSS File browser will close and the HEC-DSS file will be displayed.
- Select the pathname for the HEC-DSS record listed in the table and click Set Pathname. This will copy the selected record to the Extract Linking table.
- When you are finished selecting the HEC-DSS pathnames, from the File menu, click Close to exit the KiWIS Time Series Record Chooser dialog.