HELP_ID APP_NAME MODULE_NAME BLOCK_NAME ITEM_NAME HELP_TITLE HELP_TEXT FATHER_ID EXAMPLE_TEXT SORT_ID 70 SRHLP RPT1 Main Menu This window is displayed upon opening STORET Reporting. The current version number of STORET Reporting is show on this window. From here, you may make the initial choice of Printed Reports or File Exports depending upon the immediate need. The available reports will be different between the Printed Reports and File exports. You may exit STORET Reporting by clicking or in the upper right hand corner. Clicking from any window in STORET Reporting will close STORET Reporting. Returning to the Main Menu during a STORET Reporting session will allow you to change to a different report type. 1 76 SRHLP RPT3 Report Parameters This window is the central hub for all report parameter selection activity. Depending upon the chosen report, one or more parameter buttons will become available to provide filtering and data retrieval restriction capability. The available parameters have been predetermined for each report. 3 77 SRHLP Filter and Restricters The report control parameters fall into two general types, filters and restricters. Parameters that are filters draw selections directly from the data the user has entered and can maintain. For example, the Stations parameter will provide you a list of the Stations entered in your database. The presence of selections for a filter parameter indicates the existence of data for that parameter. Parameters that are restricters are not related directly to data the user has entered and can maintain. 76 The Activity Date Range parameter provides the capability to designate an Activity time period from which you would like to retrieve data. The database may or may not have Activities performed during the designated time period. Designating an Activity time period for which no Activities occurred would produce a null report (i.e., a report with titles and page headers, but no data). 2 73 SRHLP File Exports File Exports are tilde (i.e., ~) delimited flat files that can be imported into spreadsheets, tables, documents, or other databases. The File Exports are structured to allow data import into any viewing application with which you are comfortable (e.g., Excel, Quattro Pro, Lotus, etc.). The File Exports are intended to be manipulated by you to satisfy scientific, analytical, statistical, management, or administrative questions. 70 3 74 SRHLP Printed Reports The layout of the reports that are generated under the Printed Reports section are pre-formatted regarding field title, data placement, bolding, and so on. Printed reports may be sent directly to a printer or previewed on-screen. Previewing a report allows you to verify that the desired data has been retrieved and to perform subsequent selective printing of only the pertinent pages. Previewed reports may also be sent to a file using one of several available file types. More about the available printing and file generation options may be found under the RPT3 Report Parameters section of this user guide. 70 2 75 SRHLP RPT2 Report Selection You may select a report by highlighting the report and clicking , or by double clicking on the report. After selecting a report, you will automatically be taken to the RPT3 Report Parameters window. The reports are organized by category. Report categories and subcategories are represented in blue text. Reports within a category or subcategory may be expanded or collapsed by highlighting the category or subcategory and clicking one of the four plus or minus buttons on the left. All categories and subcategories are fully expanded whenever you access the Report Selection window. 2 78 SRHLP Operators The logical operator across all parameters, both filters and restricters, is AND. The logical operator within a parameter (i.e., selecting multiple Stations), regardless of whether it is a filter or restricter, is OR. 76 You want to get all the result data on water temperature on a given section of stream with 10 stations. You could go directly to the Station parameter and select the Stations on that particular section of stream. Then go to the Characteristic parameter, search for temperature, and choose "temperature, water". When the Result Detail report is run, the only data appearing on the report would be for those Stations that have "temperature, water". If only two of the ten selected Stations have "temperature, water" data, then only two Stations and their data will appear on the report. If none of the ten selected Stations have "temperature, water" data, then no data will appear on the report (i.e., a null report). 3 79 SRHLP Built-in Filtering Due to the hierarchical nature of STORET data, the STORET Reports Module has built-in functionality to reduce the possibility of generating a null report when using filter parameters. The available selections for a given parameter is based on the selections of previous parameters. For example, if one Organization is selected, only those Projects associated with that Organization are available for selection. If one of those Projects is selected, only the Stations associated with that Project are available for selection. In this example, the user could see before running the report if any Stations are associated with the Project, and if so, see the list of Stations. Additionally, the built-in filtering reduces the list of available selections based on known data associations to assist in easier and quicker selection. 76 4 80 SRHLP All versus Selected Indicator Field Above each parameter button is a field which indicates whether All or Selected data is being retrieved for that parameter. The default for each parameter is to provide "All" data without regard for the parameter in question. If you have made one or more selections for a given parameter, the indicator field will change to "Selected". This indicator acts as a reminder for when selections have been made, or when re-selection is necessary (see RPT4 Selection List). The only exception is when all available selections have been chosen, in this case the indicator will read All. For system performance purposes, it is not recommended to select all choices when all data regarding a parameter is desired (see RPT4 Selection List). 76 5 81 SRHLP Save Report Parameters This function allows the user to save to a file all the selections presently made from all the parameters currently available for the given report. After making selections for parameters, you may press the button to save the selections for later use (see Load Report Parameters). When the Save Parameters button is clicked, a window will appear that will allow you to save the file to the location of your choice and designate a file name. The default file name is "Par.TXT". These files may be freely renamed or overwritten and reused. There is no dependency between the parameter file name and system functionality. Note that longer file names may cause an error on some operating systems. 76 6 82 SRHLP Load Report Parameters This function allows the user to populate report parameters with selections previously saved. This may save you the time and tedium associated with making individual selections, and reduces the possibility of error. Parameters may be changed after they are loaded. This flexibility allows you to reuse a base set of parameters, and change those initial selections to fit current needs. The usefulness of the report parameters file does not end with a single report. The parameters files are not report specific and therefore can be reused for more than one report. Any parameter file can be used for any report. Reports that share the same parameters will have those parameter selections populated. Reports that do not share the same parameters will have those parameters ignored without any ill effects. To load a saved parameter file, click the button. A window will appear that will allow you to navigate to the location of the file and select the file for load 76 After hand selecting several dozen Stations, a handful of Characteristics, and choosing to get an export of result data for Activities during the month of August, the selections may be saved. Next month, you may want to get result data from those same Stations and Characteristics. The saved parameter selections can be loaded from the file, the Activity date range changed to September, and the result download run, without having to re-select a long list of Stations and/or Characteristics. You select an Organization and some Stations to generate a Station Summary report. After examining the report, you determine that these are indeed all the Stations that are needed. The parameter (i.e., Organization and Stations) selections can be saved. Now wanting to get a Result Detail report from those Stations, the Result Detail report can be selected and the same parameter file loaded. The Organization and Station selections will be automatically populated for the Result Detail report. Y 7 83 SRHLP Preview The Preview will generate the report to screen and allow a variety of subsequent functions such as: - Sending the file to a printer other than the Windows default. - Generating a Portable Document Format (PDF) file of the report. - Generating a Hypertext Markup Language (HTML) file of the report. - Generating a HTML Style Sheet file of the report. - Generating a Rich Text Format (RTF) file of the report. - Generating a Postscript file of the report. - Generating a Text file of the report. - Generating a Extensible Markup Language (XML) file of the report. - Printing selected pages of the report. - Seeing total page count. - Viewing each page of the report. - Zooming in or out (i.e., make report text larger and smaller) for easier viewing. Note: Failure to use the runtimes provided with STORET Report Module v2.0 may cause an SQL error with the Generate to File options. Clicking on the button will generate the report and send it to screen. It should be noted tha 76 8 84 SRHLP Print Clicking will generate the report and send it immediately to the default printer set in your Windows printer settings. 76 9 85 SRHLP Export Clicking will generate the file and provide a window that will allow you to save the file to the location of your choice and designate a file name. The default file name is an abbreviated name of the report which can be renamed, and has a ".txt" extension. Note that longer file names may cause an error on some operating systems. 76 10 89 SRHLP RPT1 Main Menu General This window is displayed upon opening the STORET Report Module. The current version number of the STORET Report Module is shown on this window. From here, you may make the initial choice of Printed Reports or File Exports depending upon the immediate need. The available reports will be different between the Printed Reports and File exports. You may exit the STORET Report Module by clicking or in the upper right hand corner. Clicking from any window in the STORET Report Module will close the STORET Report Module. Returning to the Main Menu during a STORET Report Module session will allow you to change to a different report type. 70 1 90 SRHLP RPT3 Report Parameters General This window is the central hub for all report parameter selection activity. Depending upon the chosen report, one or more parameter buttons will become available to provide filtering and data retrieval restriction capability. The available parameters have been predetermined for each report. 76 1 91 SRHLP RPT4 Selection List 4 93 SRHLP Characteristics No Characteristics are immediately displayed upon entering RPT4. You must enter at least the first letter of the desired Characteristic name and press to retrieve a Characteristic list. All Characteristics beginning with the letter(s) entered will be displayed. Enter more letters of the Characteristic name to narrow the search (see Search by ID, Search by Name). The list of available Characteristics is derived from the reference tables, and therefore displays any Characteristics potentially for use in STORET. Because the available Characteristics are not associated with an Organization, no Organization IDs are displayed in the first column. Also, there are no IDs associated with Characteristics, so no Characteristic IDs are displayed in the second column. 91 2 94 SRHLP Automated Data Logger Operating Periods For Automated Data Logger Operating Periods, the ordered columns display the Organization ID in the first column, Log File Name in the second column, and a concatenation of the Operating Period Start Date, Start Time, Stop Date, and Stop Time, in the third column. Log Files have no associated ID to display. The display of columns for the Automated Data Logger Operating Period parameter allows for greater selection functionality. The column displaying the Date and Time may be sorted on, or searched against to help find and select the appropriate records. 91 4 95 SRHLP Select To make a few selections from all the available choices for a parameter, highlight a row in the Available list and click button to select all Available choices, then perform deselection (see Deselect) of the unwanted rows. 91 7 97 SRHLP Deselect To remove a few selections from all the selected choices for a parameter, highlight a row in the Selected list and click . This will remove the selection from the Selected list and put it in the Available list. Alternatively, you may double-click on a row to move the selection. 91 8 98 SRHLP Deselect All It may be that you want to start selection over again, or perhaps have decided that all selections need not be made after all. In these scenarios, the easiest method would be to click the button to deselect all Selected choices. 91 9 99 SRHLP Block Select The RPT4 Selection Lists support typical Windows block selection. In order to make a group/several selections simultaneously, you may highlight a row then press and hold the or key while clicking other rows to select. Holding the Ctrl key will select only the additional rows directly highlighted. Holding the Shift key will select all rows between the first highlighted row and the second row clicked on. 91 10 100 SRHLP Sort by ID Click the button to sort the list of available selections by the parameter ID. Organization ID is always the primary sort; therefore, the sorted parameter IDs may be split across multiple Organizations. 91 11 102 SRHLP Search by ID, Search by Name The search utility locates selections from the list of Available selections. As the names imply, searching can be done based on ID or Name. This utility is most often necessary when the list of available selections is very large (e.g., thousands of available selections). The specific ID or Name will depend upon which parameter has been chosen. To use the Search function, type into the entry field the first characters, number or letters, for the ID or Name you want to find, then click or . The search is not case sensitive. When the search function is executed, the Available list will be automatically sorted by parameter ID or Name, depending on which search you choose. Your cursor will highlight the first selection found in the Available list that matches the search criteria. If a single Organization is being considered, all other possible matches will be ordered underneath the highlighted row due to the automatic sort. Organization ID is always 91 If you have chosen the Station parameter, then the Search function will operate against the Station ID or Station Name. If you have chosen the Trip parameter, then the Search function will operate against the Trip ID or Trip Name. You want to find all the Stations for a single Organization beginning with the Station name "Potomac". You can enter the letter "P" into the entry window, and click . The cursor will highlight the first Station name in the available list beginning with the letter "P" and list the Stations alphabetically by name. There may be numerous Stations that begin with "P" such as in Patapsco or Patuxent which will appear alphabetically before the "Potomac" Stations. To narrow the search and bring you closer to the Stations beginning with the name "Potomac", you may type in additional search characters such as "Po" or "Pot" and click again. Scrolling down the list would also eventually bring you to the "Potomac" Stations. 13 103 SRHLP RPT5 From Date/To Date This calendar based date selection feature facilitates choosing dates for your date parameters. Select a date by highlighting the desired day, and clicking . You may move chronologically forward or backward one month at a time by clicking the > or < buttons respectively. You may also move chronologically forward or backward one year at a time by clicking the >> or << buttons respectively. The From Date and To Date calendar defaults to today's date upon opening. 5 104 SRHLP RPT6 Stations by Location 6 105 SRHLP RPT6 Stations by Locations General 1 This feature allows you to retrieve data based on a geographical area defined by maximum and minimum latitude and longitude entries. The northern, southern, eastern, and western latitude and longitude boundaries define vertical and horizontal lines respectively that create the search area. Data will be retrieved for Stations whose Point of Record is in or on the boundary of the defined area. When a boundary is entered, let's say a northern boundary, an imaginary line is drawn around the world at that latitude. Any Station's Point of Record above this line will not be included in the report. Any Station's Point of Record on or below this line will be included in the report. The defining of all four boundaries creates the box shape. There can be many location points other than the Point of Record that are associated with the Station (e.g., Sampling, Boundary, Transect Sampling). None of these other point types are considered when determining if a Station and its associated data 104 - The Point of Record for Station A is entirely within the defined geographic area. All sampling information associated with Station A will be included in the report. - The Point of Record for Station B is entirely within the defined geographic area. All sampling information associated with Station B will be included in the report. This includes the Sampling Point for Station B because the Point of Record for Station B is within the defined geographic area. - The Point of Record for Station C is on the boundary defined geographic area. All sampling information associated with Station C will be included in the report. If there were Sampling Points for Station C, they would also be included regardless of their location. - The Point of Record for Station D is outside the defined geographic area. All sampling information associated with Station D will not be included in the report. If there were Sampling Points for Station D, they would not be included regardless of their locati 1 106 SRHLP RPT6 Stations by Locations General 2 Each boundary limit requires a Degree, Minute, and Second entry. Position the cursor into the field you want to change and enter the desired value. The up and down arrows will increase or decrease the value of the field where the cursor is placed. The default values for the selected area is the entire Northwest hemisphere. If the defaults, or any other values, are not accepted by clicking , the report will generate data without regard to latitude and longitude boundary limit specifications (see All versus Selected Indicator Field). Clicking will reset the coordinates to the Northwest hemisphere. The default values only provide a starting point for boundary limit entry. 104 2 107 SRHLP RPT7 Date Selection 7 108 SRHLP RPT7 Date Selection General 1 This parameter allows you to specify a single date, multiple dates, a date range, or multiple date ranges, in any combination. There are two ways to enter dates. The preferred method is to click on the and buttons. This will invoke a calendar based selection screen (see RPT5 From Date/To Date). Optionally, you may directly enter dates into the From Date and To Date data entry fields. Pressing the associated From Date or To Date button after direct entry, will take you to the RPT5 window, and show the day, month, and year entered in a calendar based format. This can be handy for interpreting which day of the week has been chosen, or making subsequent modifications. When a From Date and To Date have been specified using either method, click the button to move the dates into the top box. The top box lists the selected dates that will be used as criteria for data selection. If direct entry has been performed, you should verify that the date format in t 107 Entering the date "8/5/93" will yield the date "08/05/0093". The year in this case is probably not what you had in mind, and should be modified. 1 109 SRHLP RPT7 Date Selection General 2 To enter a single date (i.e., an individual day), enter the same day in the From Date and To Date fields, and click . Multiple individual days may be entered. To enter a date range, enter the beginning date in the From Date and the ending date into the To Date field, and click . Multiple date ranges may be entered. Any combination of dates and date ranges may be entered. When all entries have been made, click to load all the dates as report selection criteria. The flexibility in this part of the system allows for almost any imaginable date combination, and facilitates various analytical techniques. If only a From Date is entered when you click , the default To Date will be today's date. If only a To Date is entered when you click , the default From Date will be January 1, 1950. Removing selected dates may be done by putting the cursor in the row of the top box with the undesired date, and clicking . 107 2 111 SRHLP Automated Data Logger Installation IDs For Automated Data Logger Installation IDs, the ordered columns display the Organization ID in the first column, Installation ID in the second column, and the Installation Date and Start Time in the third column. The display of columns for the Automated Data Logger Installation ID parameter allows for greater selection functionality. The column displaying the Date and Time may be sorted on, or searched against to help find and select the appropriate records. 91 3 50 SRHLP About STORET Reports Module The STORET Report Module was built using Oracle Developer 6i Forms Builder version 6.0.8.8.0 and Reports Builder version 6.0.8.8.3. The Oracle Forms Runtime version 6.0.8.8.0 and Reports Runtime version 6.0.8.8.3 are necessary for running the STORET Report Module, and are included as part of the STORET Report Module installation. The Help Subsystem was developed using the Oracle Help utilities provided with the Oracle Forms Builder and utilizes default Oracle table construct for storing the Help text and indices. For assistance with the STORET Report Module, please contact STORET Technical Support at 1-800-424-9067. 8 101 SRHLP Sort by Name Click the button to sort the list of available selections by the parameter name. Organization ID is always the primary sort; therefore, the sorted parameter names may be split across multiple Organizations. 91 12 51 SRHLP Trips The ordered columns display the Organization ID in the first column, Trip ID in the second column, and a concatenation of the Trip Start Date and Start Time in the third column. The display of columns for the Trips parameter allows for greater selection functionality. The column displaying the Date and Time may be sorted on, or searched against to help find and select the appropriate records. 91 5 92 SRHLP RPT4 Selection List General This window provides the functionality to make selections from the list of all available choices for the given parameter. This window is invoked for all filters and some restricters. The bottom box lists all available choices (see Built-in Filtering). The source of the available selections is from user data entered into STORET via the Data Maintenance area. The top box lists the selections you have made. When a report is run, only the selections in the top box will be considered as criteria for showing data in the report. The only exception is when the top box is empty. In this case, all data will be retrieved without regard for the parameter. Clicking will include all selections in the Selected list as data retrieval criteria for a report, and/or populate the available selections for other parameters (see Built-in Filtering). The columns displayed in both boxes are ordered from left to right as Organization ID, parameter ID, parameter name or date/time. The paramet 91 If you want all results in a Result Detail report for a given Characteristic, select the Characteristic, but leave all other parameter selections alone. System performance would be compromised by actively selecting all Organizations, Projects, and Trips along with the Characteristic. However, the output in both scenarios would be the same. Your database contains 500 total Stations. Only 200 Stations have Projects assigned to them. The other 300 are therefore unuseable for Trips and subsequent Activities. Actively selecting all Projects will make available for selection the 200 Stations assigned to Projects, rather than all 500 Stations in the database (see Built-in Filtering). 1