10.3 Site Map ......................................................................................96
Introduction
Overview
The goal of the PTAGIS project is to operate and maintain the Columbia Basin-wide database for PIT Tagged fish and to operate and maintain the established interrogation systems. The data collected by this system is accessible to all entities. The PTAGIS project is seeking to enhance their online image. The presentation will be intuitive, unified, and accessible; and will provide a context for the project and the collected data. PTAGIS.ORG (pittag.org) is a dynamic, data-driven web site that provides data retrieval and repository services to researchers and the general public. In general, the services can be described as:
1. Data retrieval. 2. Data repository. 3. Interpretive overview of project and data. 4. User customization with optional login. 5. User administration for data submission. 6. Processing of users requests. 7. Library of technical documentation and newsletters and links. 8. PTAGIS software information and downloads. 9. Contact information, tech support requests, general feedback. 10. Other utilities: full-text searching, online help, external links, site map 11. Highlight system activity, special events and various notifications
The intent of this document is to capture the complete functionality of the site described above in one compact and comprehensible source. This specification does not discuss technical details of implementation, design, or PTOC administration functions. This specification is not complete. All of the wording will need to be revised several times before it is finalized. Any graphics and layout of the screens are shown here merely to illustrate the underlying functionality. The actual content and look and feel will be developed over time with the input of graphics designers and iterative user feedback.
Goals
Why are we doing this? The current PTAGIS web site and telnet application are outdated and can confuse even the most experienced user. The following is a list of primary goals for the redesigned web site:
4
1. To create a logical, intuitive structure of the published PTAGIS data set. A quick analysis of the current web site and telnet application will demonstrate ‘gaps’ or ‘jumps’ in the logical flow of information. Our redesign will be a success if the new web site is a single source and conveys a general outline of the PTAGIS data set – measurability of which is discussed in the next goal.
2. To create intuitive navigation and provide quick access to information. We will consider this site a success if it takes no longer than five minutes for an average user to find information or discover that what they are looking for is not on the site.
3. To provide contextual overview of data and project. We will consider this site a success if a new user reads the entire ‘interpretive overview’ and retains a general comprehension of the nature of this project and the data we collect.
4. To increase traffic and promote coordination of regional projects. We will consider this site a success if the overall hit-count of the new site increases by 25% after six-months of production deployment.
5. To better coordinate PIT Tag distribution and SbyC activity with new web services. We will consider this site a success if within a period of 6 month of production deployment: a) provides reliable forecasting figures for the current fiscal quarter; b) generates 75% of all tag distribution requests; c) provides 100% of SbyC activity requests for the subsequent season.
6. To provide a dynamic, data-driven site with scalable structure for future growth. We will consider this site a success if all related data appended after the immediate deployment of this site is automatically available to the user without technical modifications. We will consider this site scalable if future resources are added with minimal technical/design modifications.
Perception, Tone and Guidelines
1. The tone of all content should be authoritative, credible and most of all: neutral. 2. Assume all data presentation is ‘raw’ in nature and is not generated from any biased
analysis or interpolation. 3. The term PTOC (PIT Tag Operations Center) has been used in the past as a
reference to personnel that administrate and perform operations and maintenance of the PTAGIS systems. It has been decided the PTOC term will be replaced by the more ubiquitous term PTAGIS to reference both system and personnel in all content for this web site. However, PTOC term is still used within this document.
Project Team
Carter Stein PTAGIS Program Manager John Tenney PTAGIS Software Engineer Dave Marvin PTAGIS System Analyst Doug Clough Principal Consultant Michael Reardon Design Consultant Carol Menton Design Consultant David Steinert Design Consultant Hank Hosfield Copy Writer
Target Audience
Advanced User
Any researchers or other stakeholders (State, Regional, Federal, Tribal, Universities, Councils) who access PIT-Tag data. These users span the spectrum from very familiar with the program, to only having a cursory understanding of what the program
5
is and what information and tools are available to them. This is the target user for 3.0 Advanced Information. Example A: researcher generates weekly queries of PTAGIS data specific to their project. The query results are very large (>500K rows) and stored in a CSV file, which is downloaded to their PC. Example B: a tag coordinator visits the web site to view recent tagging activity for specific projects. Later, they decide to add an additional data contributor to submit data under their coordinator identifier. Example C: a University of Washington graduate student would like to get time-travel information on a particular species of fish for the past 25 years.
Casual User
This includes the general public. All of the electricity rate payers in the Columbia Basin. Probably don’t know much if anything about the program but are inclined to be interested in the issues. This is the most frequent user of the 2.0 Interpretive Centers. Example A: a fisherman discovered a ‘shiny thing’ while cleaning a fish. He takes it to the nearest ODFW office to find out it’s a ‘PIT something or other’. The fisherman types in ‘PIT’ + ‘Columbia River’ into a search engine and discovers our web site. They are very curious to find out ‘what in the hell’ is this thing, how did it get in there, why, is there some sort of reward, and are these people watching me right now? Example B: an Oregonian reporter is doing research for a story on endangered salmon.
Policy Maker
From the Local/State/Regional/Federal levels. Clearly interested in regional issues, but probably don’t know much about the program. This is the target user for the 2.0 Interpretive Centers. Example A: a BPA COTR is interested in the number of fish marked with a PIT Tag within a certain HUC region for the current year. Example B: a committee has been established to review the PTAGIS project and request for new funding. The committee would like to know what exactly does PTAGIS does, why they do it, and what types of mechanisms are in place to measure the project’s performance of those tasks.
Technical Assumptions
1. All users will have at least Netscape 6.2 and IE 6.0 2. Casual users will have access to at least DSL (1.5 Mbps) bandwidth 3. Advanced users may be using dial-up networking (56K baud). 4. On ‘interpretive site’, add Flash detection ‘sniffer’ and provide opportunity to download
flash. 5. Use cookies not to identify users but to remember prior navigation paths. 6. PSMFC Computer Services has a long standing policy not to allow any Microsoft IIS
server to be accessible from the PSMFC network due to security concerns; all current and future web services must run on either Apache or iPlanet servers.
6
Site Map
The site map diagram (see figure 1) depicts the overall construction of the redesigned web site. Each box represents either a web page or a collection of web pages and arrows define relationships between pages. Boxes are grouped together within frames to define classifications. The intention of this map is to provide the ‘big picture’ of the entire web site. Additionally, each box on the map contains a section number, use this as a visual index into the page level specifications described further in this document.
Figure 1 – PTAGIS Web Site Diagram
7
Page Specifications
The following sections describe functional specification for each page. Each section may comprise of one or more web pages. Each section will contain a general description and features; some key pages may contain a flow chart and/or a wireframe model. Flow charts diagram complex navigation and functionality, the legend is displayed in figure 2. A wireframe is a mockup of the page that only addresses the layout, not aesthetics. Think of it as the skeleton of the page.
Figure 2 – Legend for flow chart diagram
Overview of Data Retrieval Features
Data retrieval is a primary function of this web site and the tools for which are described in detail in their corresponding page specifications of this document. The listing below is provided to help the reader distinguish between these tools that have similar or overlapping functionality.
Data Retrieval Tool
Description Usage
4.1 Reports Provides a list of frequently requested reports to the user. There are two types of reports: ‘Interactive’ and ‘System Generated’. ‘Interactive Reports’ will prompt the user to input constraint parameters to restrict the number of records returned; however, the columns in the report output are fixed (or canned). The output is displayed by default in the ‘Results Viewer’. ‘System Generated Reports’ are automatically generated by the PTAGIS system on a schedule, output of which is an ASCII text file.
Reports provide quick answers to typical questions users ask from the PTAGIS data set. Users are not required to log into the system to access this feature. The design of this feature assumes the user has general knowledge about the PTAGIS data set.
4.1.1 Results Viewer
This viewer displays the output of a report or query. The viewer may be required to have intelligent caching mechanisms to display large number of rows generated by queries. It is not required this tool provide data pivoting, however, coded data, such as species, sites, and coordinator ids, will provide a tool-tip expansion utility.
When a user executes a report, the default output is to the result viewer; the default output of a query is to a file – due to the possibility of large number of rows in the result set; however, the user may send the output of a query to the viewer to examine the first few rows of output.
4.2 Data Viewer The data viewer provides simple answers to simple questions about the PTAGIS data set. The general concept is providing a
This tool allows the user to interact and explore published
8
3 dimensional representation of one or more basic sets of PTAGIS data that the user can pivot and navigate through to answer multiple questions in a logical, data driven manner. OLAP or ROLAP technologies may be used to implement this feature.
data sets in a way that cannot be predicted and quantified into one or more reports.
4.3 Data Files Data files are ‘raw’ text files that are fed to the PTAGIS system as input. All input data files are stored on the system. A user may download the file, modify it and resubmit the file to correct a mistake. Both the original and corrected copies are stored.
User may want to reference the original source of the data. Some fields in the data files are not stored in the PTAGIS database.
4.4 Sites Provides a geographical or geospatial representation of the PTAGIS data set. The data is partitioned by mark/recapture or interrogation sites, from which the user navigates via flash map described in 2.5 Interactive Map.
User can navigate to a particular site and access complete information about that site, in a condensed format.
8.4 Query Builder
Provides the user with the ability to build ad-hoc queries into the PTAGIS data set. This functionality replaces the current PTAGIS Telnet application functionality. Unlike 4.1 Reports – users can select which columns of data will appear in the output and can also aggregate and summarize this information.
Available only if user is logged into their account. Provides a more detailed interface to predefined views of the PTAGIS data set. The user has more control over what and how much data will be returned as well as the output format than a typical ‘canned report’.
Interface Design
The scope of this document will provide details for the design, look-and-feel and navigation of the web interface. The wireframes displayed in the page specifications do not include such detail – they are merely placeholders for functionality. However, it may help the reader comprehend the page specifications to show an example of a common, 3-tier navigation theme used by Windows XP where the left frame consists of one or more frame panels that can be expanded or collapsed using the button on the right of the frame header. When the user places the mouse over an element in the panel, the selected element exposes a hyperlink and a tool-tip description as displayed in figure 3.
9
Figure 3 – Example of Windows XP’s 3-tier navigation theme
10
Figure 3.a – Page layout demonstrating proposed look and feel of web site.
1.0 Landing Page
The sole purpose of the landing page is to route users to the area most likely to contain their interests. When an advanced user first visits ptagis.org, they proceed directly to the advanced section of the site. For casual users and policy makers, these users may be guided to the interpretive overview.
Figure 4 – Landing Page Flow Chart
Features
1. Page will contain two links – one to ‘Advanced Information’ page and another to ‘Interpretive Center’ home page.
11
2. A cookie is used to remember last section the user accessed to bypass landing page. If cookies are disabled the landing page will be displayed each time.
3. Page will display PTAGIS logo and enough information to guide the user.
Figure 5 - Landing Page Wireframe
2.0 Interpretive Center
The concept behind the ‘Interpretive Center’ is to provide background and a general overview of what the PTAGIS project is about and the type of data it collects. The center is geared for Casual Users and Policy Makers. It will incorporate HTML and Flash to provide a narrative storyboard presentation. This center presents static content which is not dynamic or data driven. The details of this section are here as companion functionality; the design and development of this center is outside the scope of this document. This section of the specification mirrors the creative brief document created by Field Trip Inc. as of 6/21/02. Interpretive Site Structure:
12
Figure 6- Interpretive Center Diagram
User Assumptions: • Average user interested in reviewing all sections of the site will be willing to devote 20
minutes to top level overview.
13
• More time will be spent by return visitors interested in exploring detail, such as the Basin Map.
• User will need 15 seconds for each page of intro text (read 50 words + review supporting graphics)
• User will need 7 seconds for a caption page (read 25 words + review supporting graphics)
Technology Assumptions:
Landing page User types in ‘www.ptagis.org HTML page loads Functionality: rollover causes IC type to change to “Requires flash Plugin v.6.0”
Main Flash Movie On click: Flash movie loads into browser
Flash Modules As user progresses through site, additional flash movies called up and loaded into Main Movie. Advantage: load timeis minimized at start, Flash modules can be easily re-purposed.
Flash Module Inserts into main Flash movie
Interpretive Center Outline:
2.0.0 Interpretive Center Home Page
Introduce Tour. Give user an idea of scope, and length of tour.
14
2.0.1 PTAGIS Introduction
Present simple description of PTAGIS project.
2.0.2 Tour Overview
Present the entire tour in a simple flow chart Starting with fish lifecycle, define juvenile Adult fish, PTAGIS role in data collection at each stage.
2.1.0 Tagging
Define the basic components of a typical tagging event; event is captured by PTAGIS system.
2.1.1 Tagger
Describe various personnel from outside agencies that perform this operation.
2.1.2 PIT Tag
Describe technology and how it functions with a tag reader. 2.1.3 Fish
Describe types of fish marked with PIT Tags within the Columbia Basin Region. 2.1.4 Information Capture
Describe how the tagging event is capture onto a computer (P3) and submitted to PTAGIS. 2.1.5 Tagging Slide Show
Presents a slideshow or video demonstrating how juvenile fish are tagged.
2.2.0 Release
Describe to user release information is also captured with the tagging event and provide the general scope of all tagging projects within Columbia Basin.
2.2.1 Basin Map of Tagging/Release Sites
Display all site locations on flash map of Columbia Basin. 2.2.2 Graph of Tags
Graph of the number of tags inserted into fish each year; describe 1% of all fish are marked with this technology.
2.3.0 Juvenile Fish Passage
Explain typical routes fish take through hydro-electric dams; which routes are or can be interrogated.
2.3.1 Passage Routes through Dam
Diagram depicting typical fish passage routes through dams
15
2.3.2 Basin Map of Dams
Display all dam locations on flash map of Columbia Basin. 2.3.4 Dam Slide Show
Provide pictures, historical background of dams in the Columbia Basin.
2.4.0 Juvenile Interrogation
Describe how juvenile fish are interrogated (or observed) passing through a dam.
2.4.1 Basin Map of Interrogation Sites
Display all site locations on a flash map of the Columbia Basin. 2.4.2 Interrogation Platform
Describe basic components of a typical interrogation platform. 2.4.3 Types of Sites
Diagram of the different types of interrogation sites and classifications.
2.5.0 Separation
Describe that fish not only observed but also routed through facility passages. 2.5.1 Basin Map of Separation (SbyC) Sites
Display all SbyC site locations on flash map of the Columbia Basin 2.5.2 Operational Diagram
Describe mechanics for fish separation, allow user to click on components and view actual photographs.
2.6.0 Recapture
Convey to users that tagging operations may encounter a fish already tagged, PTAGIS records this event.
2.6.1 Recapture Diagram
Explain process with a simple diagram, some types of sites (traps etc.) and projects (radio tagging etc.). 2.6.2 Slide Show
Show actual photographs of fish recaptured and scanned for a PIT Tag.
2.7 Adult Fish Passage
User understands when fish return to swim upriver, they’re observed by PTAGIS systems.
16
2.7.1 Basin Map of Adult Detection Sites
Display all adult detection sites on a flash map of Columbia Basin. 2.7.2 Fish Passage Routes
Revisit diagram from 2.3.1 and high-light ladder route. 2.7.3 Adult Detection Equipment
Diagram describes how interrogation platforms are different for adults than juveniles. 2.8 Mortality
Explain the complete life-cycle of a fish can be recorded by the PTAGIS system. 2.9 Research
Explain that PTAGIS not only collects data, but makes it available to for research to anyone.
2.9.1 Researcher and Issues
Describe the types of research projects and issue they’re trying to solve. 2.9.2 Advanced Information Site
Present a high-level overview of the structure of the ‘PTAGIS Advanced Information’ web site. 2.9.3 Quality Control and Operation and Maintenance
Explain the quality control measures PTAGIS takes to ensure the validity of the PTAGIS systems; also explain operational and maintenance duties. 2.9.4 PTAGIS Network
Explain the agency hierarchy and how the PTAGIS project fits in; also provide brief history of the PTAGIS project as well has charter.
3.0 Advanced Information
This is the home page for the ‘Advanced Information’ section of the PTAGIS web site.
Features: 1. Users can bypass the landing page by directly linking to this page – or a cookie is
used to automatically route users to this page. 2. This page (figure 8) provides a brief description of the project/data contained within. 3. Special Notices and News Events about the PTAGIS project are displayed in left
frame of figure 9. These events notify users about such things as server maintenance notices, newsletter releases, software releases and other anomalous events. These events are dynamically displayed from a file or database when the page is refreshed and have some sort of an expiration mechanism.
4. Navigation is described in figure 8. 5. Page layout of navigation and general look-and-feel of web site is displayed in figure
9.a.
17
Figure8 – Advanced Home Page Navigation
Figure 9 – Advanced Information Home Page Wireframe
18
Figure 9.a – Advance Information Home Page Layout
4.0 Data
Users can access data in this section without a login. Web pages defined in this section provide a set of ‘common data’ to the end user, such as canned reports and raw data files. Data access is read-only and restricted so that the user cannot generate requests that will consume a large amount of system resources. If the user needs data more specific than what is provided in this section, they will logon and use more advanced tools. When the user clicks on the Data menu heading, a general page is displayed (figure 10) to explain the different tools available to the user for accessing data in this section. PTAGIS data is collected in “near real-time”, therefore this page should indicate to the user the date and time of the last successful data load and when the next scheduled load will occur. An additional graph will display general year-to-date subtotals of various data processing, such as ‘species tagged’ or ‘interrogation by site’ to demonstrate the project’s capability for acquiring large amounts of data in a timely manner. Features:
1. Clicking on Data will display the ‘Data Home Page’ - however, users can proceed directly to a subsection using the toolbar and mouse-over/dropdown.
2. Schedule of data load will be displayed on this page. If interrogation data is loaded on-demand, then perhaps link to a pop-up window showing a table of sites and date and time of last upload; have a similar table showing latest tag files loaded.
3. Input for graphs should be computed nightly instead of real-time.
19
Figure 10 – Data Home Page Wireframe
4.1 Reports
This section provides the users with a list of common, predefined reports of PTAGIS data. There are two styles of reports: Interactive reports require input from the user and produce dynamic content in the 4.1.1 Results Viewer; System Generated reports are predefined content without user interaction – output to an ASCII file. Both styles of reports are displayed on the same page, visually separated with a slide bar tool in the left frame. The page specifications for this feature describe general functionality of a ‘canned reporting system’; other functionality may be driven by a specific toolset and/or database architecture described outside the scope of this document.
4.1.1 Interactive Reports
Interactive reports require the user to input conditional parameters to limit the number of rows returned in the output. The user can select a date range or a particular code – it depends upon the particular report selected as to which parameters are available. Once valid input is selected the View button becomes available; when pressed it displays the output in the Results Viewer. The columns in the output are predefined and cannot be changed by the user at runtime; however the tool used to display the results may allow the user to hide or sort selected columns. Interactive reports have these additional features:
a. The report page (figure 11) displays a listing of all PTAGIS reports in the
left frame that are available to the user – separated from System Generated Reports by a slide bar.
1. When the user selects a report, the center frame displays any ‘canned’ input boxes for parameters associated with that report.
20
2. User can press More Info button to get an online help topic with more detailed information about the selected report.
3. If the user is logged in, the Save to Account button will be displayed, which allows the user to save the completed input parameters associated with report to their personal profile for quick access. This button is enabled when the user has completed all of the parameter input.
4. After entering valid parameter input, the user can press the View button to execute the report and view the results (4.1.2 Results Viewer). If invalid input, users will be redirected to the input page and a warning will be displayed.
5. The report feature must be constructed such that new reports can be easily added in the future without modification to the web interface or back-end processes.
6. Interactive Reports slide bar is open by default on first access of page.
Figure 11 – Interactive Reports Wireframe
21
Figure 12 – Flow Chart for Interactive Report Processing
The following table represents all Interactive Reports that will be initially created for the production web site:
Interactive Report Name
Description Parameters Legend (Y/N)
Interrogation Site Status Report
Displays load status and data gaps of all interrogation files by site and date period
Site Code; Date Range Y
Complete Tag History
Displays distribution, mark/recapture and interrogation information about a single or group of tag codes.
Tag Code Y
Duplicate Tag Records
These interactive queries let you locate tagging ‘Files with Duplicate Tags’, and then view or download the ‘Duplicate Tag Records’ in those files.
File Mask, Sort Type Y?
Tag File Content Summary
Check the number of new tags, recaptures, mortalities, etc. in your Tag Files.
File Mask, Date Range, Show/Hide Versions
Y
Adult Returns This query returns a list of PIT-tagged fish detected in the adult ladders and traps at Columbia and Snake river dams. Data are available for eight locations.
Ladder; Detection Period; Hide Orphans
Y
Weir Counts Review the individual adult ladder weir counts at Bonneville, McNary, and Wells dams
Ladder, Period Y
Site Tally Reports Counts of PIT-Tagged fish by Exit Monitor for Selected Interrogation Sites
Cumulative Monitor Stick Tag Testing Reports
PTTP Data Submission Report
User provides a tag coordinator or interrogation site code and a relative date range , output is all data submission for that coordinator or site code.
Coordinator ID or Site Code, Relative Date Range
22
4.1.2 Results Viewer
The results viewer displays a tabular view of the output of a report or query.
Features: 1. The result viewer should provide a consistent interface for general
report/query output. If a particular report has a legend associated with it, a Legend button will be available to provide a popup legend window.
2. Viewer will have ‘code lookup’ intelligence to identify coded data columns that can be hyperlinked to provide additional information about the code when clicked.
3. Viewer results can be saved to a file – the user will be prompted as to the type of file (HTML, CSV, ASCII, PDF and XML) and destination (client PC or profile storage).
Questions:
1. Should the viewer display only first N or M records? Pros: good for large results sets; Cons: requires implementing a sophisticated cache mechanism; sorting and saving to a file become more difficult. Answer will require more analysis of types of reports/output.
2. Can the results viewer be reused for displaying results from a query generated with the query builder tool?
3. Can this functionality be provided by a third party tool?
Figure 13 – Results Viewer Wireframe
4.1.3 System Generated Reports
These reports are generated by PTAGIS automatically, usually on a nightly or weekly schedule and made available to the user for downloading. The output of these files is stored in ASCII text, usually CSV. Features:
23
1. User clicks on System Generated Reports slide bar to view the listing of
report types under this header in the left frame of figure 14. 2. User clicks on a report type and all associated report files are listed in the
main frame, with Report File name, Modified and Size in KB. User can sort on these rows by clicking the column header.
3. When the user selects a report file in the left frame, a verbose description of the file’s content is displayed underneath the selected report.
4. User can select one or more files at a time. 5. Users can View the first selected report file. The entire output will be
displayed in a separate browser window. User can use native browser functionality to print and save the report.
6. Download command will use native browser functionality to download all selected report files to the user’s local system. The download mechanism should detect user’s platform to ensure compatibility of the file format (Windows/Unix/Mac).
7. Copy to Account command will place a copy of all selected report files into the user’s 8.2.4 My Files. This command is enabled only if the user is currently logged into their account.
Figure 14 – System Generated Reports Wireframe
The following table represents all System Generated Reports that will be initially created for the production web site: System Generated
Report Name Description
TMT Files Technical management team reports SMP Observations By Day
Year to date count of how many interrogations at each interrogation site of certain Species from each release site, grouped by day of year.
Annual Tagging Summary Reports
Interrogation Errors Reports validation anomalies in interrogation files generated by obs_val.pl.
24
4.2 Data Viewer
The page specification for this tool are more conceptual than concrete. This tool will allow the user to explore and interact with published sets of PTAGIS data in a simple, intuitive, query-to-query interface. Users can select a population of fish, ask a simple question and get a simple answer and then pivot on the answer to ask more specific questions. OLAP tools may drive the functionality of this section; however the conceptual specifications are used to make sure the goals of this tool are fully realized. PTAGIS has a mandate not to perform any analysis of the data it collects to preserve its neutral position. Therefore, a factor to consider when specifying this tool is the publish data sets and functions for interacting with the data should not exceed simple aggregations of the data.
Figure 15 – Abstract Schema for Data Viewer
The wireframe below (figure 16) is an conceptual example of what the data viewer tool could be. As with reports, when the user presses the ‘View’ button the ‘Results Window’ (4.1.2 Results Viewer) is displayed. Pressing the ‘Save to Profile’ button will prompt the user to save the viewer settings to their profile (if user logged in).
25
Figure 16 – Conceptual Data Viewer Wireframe
Features:
1. Add meta-data for any coded input such as sites, organizations and coordinator id. 2. Allow users to save context of viewer to their profile to recall again. 3. May be able to reuse functionality in Query Builder tool for estimating processing cost.
Examples of typical questions or interactions with the PTAGIS Data:
1. How many Chinooks were marked in the Lower Snake Province (set of HUC codes)? i. Of these fish, how many were observed?
1. Of the observed fish, how many returned as adults (at fish ladders or hatcheries)?
2. Of the observed fish, how many were identified as Rice Island Mortalities?
3. Of the observed fish, give me an enumeration of their flag codes. 2. How many fish, by species, were marked/recaptured at locations for a particular
tagging coordinator? i. What happened to these fish (observations, recaptures and mortalities)? ii. Of these fish that were de-scaled, what was their subsequent observed
behavior? 3. Given a known length (and/or weight) distribution at tagging, correlate the rate of
detection with a particular length (chart and table). 4.3 Data Files
A data file is defined in this document to be any “raw” ASCII file used as input into the PTAGIS database. All of these input files are stored on the PTAGIS server and this feature allows users to access them from the web. There are two basic types of data files: tagging files are used to capture the initial tagging event between fish and tag; interrogation files record automated observations of fish with tags throughout the region. Tagging files can be corrected and
26
resubmitted to PTAGIS – therefore multiple versions of a file can be stored on the server with a version number appended to the file name. Features:
1. File types are displayed in the left frame, and similar to the report page, when the user clicks on a type, the data files and any directory structures are displayed in the center frame.
2. Multiple versions of the same file are displayed with an expand/collapse “+”, where the most current version is always displayed as the parent and subsequent versions are displayed as children. Currently, only tagging files are versioned.
3. Users can sort files ascending or descending order by clicking on column headings. 4. The user can navigate through the conventional directory structures. 5. Users can view a data file by double-clicking it with the mouse – a pop up window will
display the contents of a file, where the user can print or save the file to local disk directly from the native browser.
6. Users can download or print the file without viewing it by selecting a command from the conventional right mouse pop-up menu.
7. Files and directories will display date modified and file size in center frame. 8. User access is read-only. 9. Data file types are ASCII, or perhaps XML. 10. If user is logged in, a Save to Account button will be displayed so that user can save
copies or short-cuts in their storage unit for quick access or as input into queries/reports. If short-cut to a file is used for a query, only the most current version of a file will be used for input into a query parameter.
Figure 17 – Data Files Wireframe
The following table represents all PTAGIS data files that will be made available to the public:
Data File Type Description Interrogation Created with either MiniMon or MultiMon and processed this year,
grouped by site code folders. Tagging All files all years, grouped by tag coordinator id folders. Rejected Tagging Files Files rejected from the loading queue due to errors in format or
content, grouped by year with current year displayed by default.
27
4.4 Sites
This section presents the PTAGIS data set geographically partitioned by data collection sites. The data collection sites are grouped into overlays and the user can choose one or more to view on an interactive map of the Columbia Basin region. The user can select a site from the map, or the synchronized description text in the left frame to navigate to 4.4.1 Site Overview for detailed information on that site. The overlay displaying dams allow the user to drill-down to a lower resolution map showing interrogation sites for the selected dam. Features:
1. The overlays groups for the interactive map are displayed in the table below. User can select one, none or all of the overlays to display on the map at once.
2. Data sites are grouped into categories, listed in table below. The user should be able to identify data sites by their category grouping with a special icon or other type of visual marker. Categories are not mutually exclusive; data sites can appear in one or more categories.
3. The legend in the left frame (figure 18) allows the user to select one or more overlays onto the map.
4. When the user clicks on a site on the map the slide in the left frame displays a description of that site, and for the case of dams any interrogation sites for that dam; conversely, user selects slide and dam is highlighted in map.
5. When the user clicks the link on the site – they are directed to for selected site. 6. User navigates to site page by clicking on site link in legend – if the site contains
subordinate sites, such as Bonneville Dam, a lower resolution map is displayed with subordinate site locations, BO1, B2J, BO2 etc.
7. Site data is structured so that it’s intuitive for all types of audience.
Questions: 1. Should this section only include Interrogation Sites? Tagging and Release sites may
have very little information associated with them. a. Answer – to be determined at implementation. We can design an object
model to support all types of data collection sites such that the creation of all site content would be automated.
28
Figure 18 – Sites Home Page Wireframe
Figure 18.a – Site Home Page Layout Interactive Map Overlays
29
Overlays Notes Dams Hydro-electric dams on the Columbia Basin Region, whether they support PTAGIS
operations or not. Interrogation Displays all PTAGIS interrogation sites – some sites may be condensed into a single
dam location and then displayed on an expanded, lower resolution map. Tagging/Release Sites All tagging and release sites. Hatcheries All hatchery facilities in the Columbia Basin Region Acclimation Ponds All acclimation ponds that support PTAGIS operations in the Columbia Basin Region Other Landmarks Includes towns, smaller tributary rivers and other geographical landmarks. Data Site Categories Data Site Categories Description Data Type Type I Interrogation Site PTAGIS performed installation
and all operation and maintenance.
Interrogation
Type II Interrogation Site PTAGIS consulted on installation, however, O&M is performed by another entity
Interrogation
Type III Interrogation Site Installation and O&M performed by another entity.
Instream Interrogation Smaller interrogation sites that monitor fish passage in streams.
Interrogation
Tagging Sites Sites where fish are marked with a PIT Tag.
Mark/Recapture
Release Sites Sites where fish are released, usually after a tagging event.
Mark/Recapture
Hatcheries Facilities that rear fish and release them into the wild.
Mark/Recapture/Interrogation
Acclimation Ponds Remote ponds used to acclimate fish to be released into the wild
Mark/Recapture/Interrogation
4.4.1 Site Overview
This page (figure 19) displays information for a given site selected by the user from the interactive map on the 4.4 Sites page. Sites can be of type interrogation, tag/release, and hatchery. Interrogation sites have more detail than release and hatchery. The site page lists categories of information in the left navigation frame for the user to choose from.
Features
1. Overview section displayed by default 2. Contains a brief site description section. 3. Summary graphs – interrogation sites will have #obs by month and/or year;
release/hatchery sites: #mark/recaptures. Should give user a general indication of how much site activity during the current year.
4. Interrogation sites will have thumbnail of current site configuration which can be displayed in a pop-up window.
5. Interrogation sites will display a table of operational dates for each year in the Site Description section.
6. Page Title will display a visual indicator as to the type of site.
30
Figure 19 – Site Overview Wireframe
Figure 19.a – Site Overview Page Layout
31
4.4.2 Site Photographs
This section of the site viewer displays any digital photographs taken of the selected site. Features:
1. Displays thumbnail and description for any pictures collected by PTAGIS for the given site (figure 20). Description contains file name, size and date.
2. Alt-text image attribute will contain a summary description of the photograph so user can mouse-over to see pop-up on thumbnail or full image.
3. User can display full image in pop-up window by clicking on thumbnail; each click on an image will launch a separate pop-up window.
4. User can save image to local file or print using native browser functionality. 5. If site doesn’t contain any photographs, link is disabled in left navigation
frame.
Figure 20 – Site Photographs Wireframe
4.4.3 Site Reports
This section (figure 21) contains reports specific to the site selected in 4.4 Sites. Even though the same reports can be run in the 4.1 Reports section, users may navigate to this section from interpretive site, or site personnel may link directly to the 4.4.1 Site Overview page, therefore the redundancy is needed. Features
1. Reports fall into two data categories for all sites: interrogation and mark/recapture.
2. Report link in left navigation expands to display available reports for given site; when user clicks on specific report – output is automatically generated in main frame using 4.1.1 Result Viewer.
3. Reports should be structured such that only two parameters are needed: site code and a date range.
32
4. Date range parameters will be given a default value, specific to the report. However, user can change this after running the report by selecting a date range in the drop-down box in report description header.
5. Report content should target all audience types.
Figure 21 – Site Reports Wireframe Site Reports: preliminary reports that are available in this section: Report Name Description Type Interrogation Site Status Report
Displays status of loaded data for a site and any gaps in data collection.
Interrogation
CEA Displays yearly coil efficiencies for a given site Interrogation DGE Interrogation ADE Interrogatoin Tag File Contents Summary
Displays a summary for all tag files loaded for a given site Mark/Recapture
Project Summary Displays a summary of all projects, organizations, and tagging coordinators that marked fish on a given site
Mark/Recapture
Species Summary Displays a cross-tab of species marked for a given site Mark/Recapture
4.4.4 Site Data
Site data section (figure 22) displays relevant data for a selected site. If the type of site is interrogation, then interrogation data files loaded for a select period of time are displayed; if type of site is tagging, then all tagging files submitted using the selected site as a tag/release site grouped in year folders are displayed. Features
1. Data files are displayed in similar format as described in 4.3 Data Files, however tagging and interrogation files will be displayed differently: a. Interrogation files will default to site directory displaying year folders.
33
b. Tagging files are displayed similar to a search result defined in 4.3 Data Files and are out of context of actual storage location.
2. User dbl-clicks a file, the contents will be displayed in a browser; user can use native browser functionality to print or save to local file.
3. Navigation is restricted to default, top-level view; users cannot navigate to another site’s storage directly; they must select the site by navigating to 4.4 Sites.
4. All files, regardless of type, are displayed with file name, date modified and size.
5. Users can sort files by clicking on column headers.
Figure 22 – Site Data Wireframe
4.4.5 Site Configuration
This link/page (figure 23) is only available for interrogation sites. It describes current and any historical equipment configurations at the selected interrogation site. This information is important to outside entities performing in-depth analysis of PTAGIS data. Features
1. Current diagrams are in ASCII text format as displayed below. However, PITTag Specification Document contains diagrams of current configurations and possibly past configurations. If diagrams do not exist, the textual description may need to be converted to a more human readable format or visual diagram.
2. User can select between current and historical configurations using the drop-down box.
3. By default the current site configuration is displayed. 4. User can use native browser functionality to save or print configuration
diagram. 5. Web-enable diagrams such that user can select one or more gates or
antennas to display the CEA or DGE report for the selected item(s).
34
Figure 23 – Site Configuration Wireframe
Example of a current, ASCII text description of a site configuration: Seq Nbr 140 -> 22-Jan-01 To Present Comment: Installed SAMPLE monitor and coils. Monitors in Sort_Str sequence: Nbr 1 -> SbyC SEPARATOR GATE
Mon_Ctgry_Str: RVRSbyC Entry_Y_N? Y, Exit_Y_N? N, Sort_Str: 1 (Coil,Controller): (A1,00) (A2,03) (A3,10) (A4,13) Nbr 2 -> RIVER EXIT Mon_Ctgry_Str: RVR, Entry_Y_N? N, Exit_Y_N? Y, Sort_Str: 2 (Coil,Controller): (81,01) (82,11) Nbr 3 -> SbyC EAST TANK Mon_Ctgry_Str: SBC, Entry_Y_N? N, Exit_Y_N? N, Sort_Str: 3 (Coil,Controller): (E1,02) (E2,12) Nbr 4 -> SbyC WEST TANK Mon_Ctgry_Str: SBC, Entry_Y_N? N, Exit_Y_N? N, Sort_Str: 4 (Coil,Controller): (F1,04) (F2,14) Nbr 6 -> SAMPLE ROOM Mon_Ctgry_Str: UNK, Entry_Y_N? N, Exit_Y_N? N, Sort_Str: 5 (Coil,Controller): (51,00) (52,00) Nbr 5 -> SAMPLE / SbyC EXIT Mon_Ctgry_Str: RVR, Entry_Y_N? N, Exit_Y_N? Y, Sort_Str: 6 (Coil,Controller): (91,05) (92,15) (93,16)
35
4.4.6 SbyC Site Activity
This section will display any Separation by Code (SbyC) activity for the selected interrogation site. Activity is grouped into the following four sections:
4.4.6.1 SbyC Site Overview
Displays (figure 24) points of contact for coordination and a brief description of the project(s) related to an interrogation site for the current year. Features:
1. Provide a thumbnail link to diagram of current configuration diagram of interrogation site –when clicked displays in pop-up window.
2. Need content to convey in project description the placement of SbyC nodes within the site for each project.
3. Need to include content of integration of DGE and SbyC management operation systems.
Figure 24 – SbyC Activity Overview Wireframe
4.4.6.2 SbyC Site Summary Report
Displays (figure 25) a summary report that defines each action code associated with selected interrogation site. Features
1. Some action codes that define multiple projects will display an expandable listing. A total of all tag codes is displayed at the bottom of the report.
2. User can print this report; all nodes will be expanded in the printout. 3. This report will have a year selection box at the top so users can
view reports from previous years.
36
4. User should have capability to launch report to a separate window to do yearly comparisons.
Figure 25 - SbyC Site Summary Report Wireframe
4.4.6.3 SbyC Schedule
Creation of a (separate) new SbyC calendar object to perpetuate each state change in the SbyC schema suite. Potential state changes include Added, Deleted, Modified, Enabled, Appended, Subtracted, and Disabled. These state changes can be tied to existing SbyC 'site' and 'AC' object definitions. SbyC Event Calendar output can be tabular (by site and/or AC) or graphical (or pseudo-graphical) using a Gantt or calendar motif. Features
1. This report should be implemented with the standard expandable\collapsible listing as previous summary report.
2. User can print this report; all nodes will be automatically expanded in printout.
3. This report will have a year selection box at the top so users can view reports from previous years.
4. User will have the capability to launch the report into a separate window to do yearly comparisons.
5. By default, the most current year is displayed. 6. Schedule is currently only specific to sub-sampling, need to provide
content for dates the projects are active as well.
Report format: Start Date End Date Action Code Daily Limit Sample Limit 5/10/2002 10:00 5/12/2002 10:00
Report format will synthesize "expected" action reported by SbyC software with "observed" action as partially implemented by SBCA and DGE processes. Target audience is SbyC Project leader; purpose of report is to confirm or refute that SbyC Diversion Actions are occurring (have occurred) as expected. Diversion locations above facility sample gates should include both expected and unexpected sample diversions in operational audits, if feasible. Report scope should include PIT tags from the general population, as well as from identified Action Code groups. Features
1. This report should be implemented with the standard expandable\collapsible listing as previous summary report.
2. User can print this report with all nodes expanded. 3. Currently, this report is output to an ASCII file and would have to be
modified to HTML/XML. 4. This report should have a year selection box at the top so users can
view reports from previous years. 5. User should have capability to launch report to a separate window to
do yearly comparisons. 6. By default, the most current year is displayed.
Report Format:
Period AC R_R R_T T_T T_R SMP SnTYTD
DEFA 36927 0 0 0 0
11 RAPH
933 0 0 0 0
253 B2JTS
T
1 0 0 0 0
9/01/01 DEFA 1 0 0 0 0
11 RAPH
300 0 0 0 0
9/02/01 DEFA 0 0 0 0 09/03/01 DEFA 0 0 0 0 0
Legend of Abbreviations of Report
Abbreviations Description YTD Year to Date AC Action Code R_R Tally of fish intended for 'river' dispositon and detected on
'river' path T_T Tally of fish intended for 'transport' dispositon and detected on
'transport' path T_R Tally of fish intended for 'transport' dispositon and detected on
'river' path
38
SMP Tally of fish detected on 'sample' path SnT Tally of fish detected on 'sample and transport' (S+T) path Sum R_R + R_T + T_T + T_R (NOTE: SMP and SnT are not
included in this count) SbyC% Separation efficiency: 100 * (R_R + T_T) / Sum D_R Diversion ratio: (R_R + T_R) / Sum
4.4.7 Site Events
This section displays (figure 26) a list of postings about site activity, such as hardware/software modifications, power outages, transceiver status, and any other events or issues for a particular interrogation site. The postings are from PTOC personnel and other users and the web interface provides a familiar newsgroup features including threaded discussions. This section is site specific, however, a more general tool for viewing ‘all events’ is discussed in the 6.4 Links section. Features
1. Postings are displayed in chronological order; however, users can change the sort order by clicking on any of the columns.
2. Postings are read-only. If a user is logged in, they can create a new post or reply to an existing post.
3. New or replied posts will be entered in a pop up window. User’s login name will default as the ‘From’, current date and time will default as the ‘Sent’. User will enter up to a 100 character ‘Subject’, a textual ‘Message’, and then ‘Save’ the post.
4. Postings will be moderated; site administrator can control content using the PTOC Central website.
5. Site administrator will be CC’d on all postings. 6. Users can submit postings via email interface. 7. User can print all or selected postings for the selected year; threaded posts
will be automatically expanded when print. 8. User can select the year for which to display, by default, current year is
displayed.
39
Figure 26 - Site Events Wireframe
5.0 Software
This section contains information about PTAGIS client software available to the user. PTAGIS client software is used to collect mark/recapture and interrogation data in the Columbia Basin. Currently, there are three applications available for download: 5.1 P3 and 5.3 PITTag2 collect mark/recapture data; 5.2 MiniMon collects interrogation data. In addition, a tools section provides the user with the ability to download useful utility programs. Features:
1. Page (figure 27) provides a general overview of all PTAGIS applications in context of the entire project, for example: ‘P3 collects mark/recapture information specific to the Columbia Basin region and submits tagging files submitted under the supervision of a tagging coordinator’.
2. Mouse-over a link in the left frame displays general description in main frame. 3. Clicking on software link will take user to that software’s home page. 4. By default, a ‘Welcome to Software’ page will be displayed in main frame of this
window. 5. Tools section contains useful web utilities for users outlined in section
40
Figure 27 – Software Overview Wireframe
Figure 28 – Software Framework Diagram
5.1 P3
This section has already been redesigned to serve as a test platform for new browser technology. Some of the design may have to be upgraded to match look-and-feel of PTAGIS website. Visit www.pittag.org/P3 for more information.
41
5.2 MiniMon
This software application is used to monitor interrogation site hardware and collect data and submit the data to PTAGIS. Content for this section already exists, and can easily be adapted to the framework defined in section 5.0; however, design will need to be upgraded for look and feel. The next version of MiniMon has not been scheduled for design and development. 5.3 PITTag2
This software is now considered ‘end-of-life’ and is the predecessor to P3. This software is available for legacy systems and equipment configurations not supported in P3; this message should be made clear to the user. Content for this section already exists and can be adapted to framework defined in 5.0. 5.4 Tools
This section provides useful tools, some web-enabled, and links to download others. User clicks on tool link in left pane, if it is web-enabled tool, the input to the tool is displayed in the main frame. If the tool link is a download, such as Adobe Acrobat, users get a brief explanation of what the tool does and a link to redirect them to the tools website.
Tool Description Type Tag Conversion Allows users to input one tag or a browse and select a file of tag
codes and convert them from decimal to hex or hex to decimal. User can download output when conversion is completed.
Web-enabled
Julian Date Conversion
User can type in a date and covert it to or from Julian format Web-enabled
DOS File Conversion
Convert files from UNIX to DOS. Web-enabled
WinZip Provide a link to a free zip/unzip utility Link Adobe Acrobat Provide a link to free Adobe Acrobat reader Link Flash Provide link to free Macromedia Flash browser plug-in Link
6.0 Library
The PTAGIS library is comprised of three sections: documents, newsletters, photographs and links. When users click on the Library navigation link, they are directed to a web page explaining the sections and contents of the PTAGIS library. Users can navigate to a particular section by clicking on the appropriate listing in the left frame – the main frame will contain the contents of that particular section; from there the users can select a document, newsletter or a link to launch into a separate window.
6.1 Documents
This section of the library displays all PTAGIS documentation. The document listing in the main frame consists of a document title, a date published, a brief description and a link to view the document in PDF (if available). When the library is first displayed, a welcome splash page will be displayed informing the users of the types of sections available; page title is tied to links in left frame.
Features
1. Document tile is also a hyperlink such that when clicked, the document is launched into a separate browser in HTML format.
2. If PDF version is available, a link under the description will be displayed which will launch the document in ADOBE acrobat.
42
3. Somewhere on the PTAGIS library home page, there should be a link directing users to download the free adobe acrobat reader.
Questions:
1. Due to the amount of documents and photographs, wouldn’t it be easier to just publish them as files with self describing names?
a. These documents and photographs could be managed with a content management or file server that would enable us to publish attributes to associate with each file.
b. A quick review of PTAGIS documentation will show that very few documents have introduction or stated purpose; therefore it is necessary to provide descriptions for all published files and provide an provide a interface such that the users need not download the file to discover it’s purpose.
Figure 29 – Document listing of the PTAGIS Library
Documents in the PTAGIS Library
Document
Description
Published
PDF?
PIT Tag Specification Document
Y
PIT Tag Marking Procedures Manual
1999 Y
PTSC Charter P3 Online Help 2002 MiniMon Online Help 2000 PITTag2 Online Help 1999 PTSC Meeting Yearly
43
minutes Proposal for Council Solicitations for ISRP
This section of the PTAGIS library consists of all of the periodic PTAGIS newsletters, arranged by year.
Features
1. Newsletters are grouped by year and volume in descending order.
2. A link at the top of the main frame will direct users on how to submit information to PTAGIS via a pop-up window or request form.
3. Newsletters can be displayed in HTML or PDF; a link will be provided for both.
4. Newsletters are launched into a separate browser.
5. By default, the most recent newsletter is automatically selected when users first click on the ‘Newsletters’ navigation link in left frame.
6. A graphic will indicate whenever a newsletter has been published within the last two weeks.
7. Newsletters will be designated by volume and issue numbers.
8. Field trip has been tasked to design the look and feel of the newsletter, web and print.
9. Provides a simple mechanism for PTOC to add future newsletters.
44
Figure 30 – PTAGIS Library listing of Newsletters
6.3 Photographs
This section of the PTAGIS library displays general photographs or diagrams. This section will have the same functionality as 4.4.2 Site Photographs.
Features:
1. Displays thumbnail and description for any pictures collected by PTAGIS for. Description contains file name, size and date.
2. Alt-text image attribute will contain a summary description of the photograph so user can mouse-over to see pop-up on thumbnail or full image.
3. User can display full image in pop-up window by clicking on thumbnail; each click on an image will launch a separate pop-up window.
4. User can save image to local file or print using native browser functionality. 5. Provides a simple mechanism for PTOC to add or remove pictures from library.
This section of the PTAGIS library displays links to other web sites that are related to PTAGIS project.
Features
1. The Links navigation is expandable in the left frame and presents a list of the following categories of PTAGIS links:
a. Publications
b. Operations
c. Research
d. Federal
45
e. State
f. Public Utility Districts
g. Universities
h. Other
i. Manufacturers
j. Photographs
2. Links will launch into a separate browser.
3. The complete listing of current PTAGIS links can be found here: www.pittag.org/ptoc_links.html.
4. Provides a simple mechanism for PTOC to add/remove links.
Figure 32 – PTAGIS Library Links Listing
7.0 Requests
This entire section has been moved under 8.4 Services.
46
8.0 User Home Page
Users that choose to create a PTAGIS web account can have access to a custom home page, advanced query builder tool, storage, and other advanced web features. The general purpose of the login account is so that PTOC can monitor resource usage by user and identify user for secured features.
When a user first accesses the PTAGIS web site, the navigation link will display a Logon button. When pressed, a dialog will prompt users to enter their account and password, or, create a new account. Once logged in, the navigation link will display My Home Page – details of which are described in this section.
8.1 Logon
This page presents the user with the option of entering in their account name and password, or creating a new PTAGIS account.
Features:
1. Validation error message appears if the user inputs wrong account name and password.
2. Links for Login, New Account, Forgot Password and Privacy Policy are displayed in the left navigation frame (figure 34).
3. Built-in browser support will supply any default login values.
4. Once user login is authenticated, the Logon navigation is replaced by ‘Home Page’ (see section 8.2).
5. Users cannot designate themselves as a tag coordinator; this must be done by PTSC approval and PTOC administration.
6. All PTAGIS data presented to users (with our without an account) are read only. Any process that updates PTAGIS data is controlled by special roles granted to specific user accounts via PTOC administration.
7. Track login and feature usage (by general summary, not by user) to help gauge performance and priority.
Questions:
1. Should passwords expire? Should accounts not accessed for a period of time expire?
a. Answer: PTOC will perform audits of all user accounts on a periodic basis and notify users if their accounts have not been accessed for a certain amount of time. If users fail to respond within a reasonable amount of time, their account will be disabled but not removed. Over an extended period of time
2. Should passwords be automatically generated and emailed to user before they can access system (light-weight security)?
a. Similar functionality for forgotten passwords. Answer: Yes, see section 8.1.1 New Account for more information.
47
3. Should email accounts be consider unique (user cannot create multiple accounts from one email address)?
a. Answer: Yes see section 8.1.1 New Account for more information.
4. What other specifications need to added here to secure other functionality – namely requests. For example, when user logs in, they will have more options available in the Requests menu.
a. Answer: Requests were moved from main navigation and placed under 8.0 User Home Page; refer to request page specifications within this section.
5. Do we need to specify role-based security: User, Tag Coordinator, Tag Distributor etc?
a. Answer: yes and no – PTOC administrator will set a flag in the user’s account whether they should have access to certain functions, however, currently there isn’t a need for a traditional, robust role based security mechanism.
48
Figure 33 – Logon functionality flow chart
49
Figure 34 – Logon Wireframe
8.1.1 New Account
This section provides an interface for users to create a new ‘web’ account to access advanced and customizable features of the site. User will supply information in two pages, first page all fields are required and second page all fields are optional. Once account fields are completed, the user presses a button to create new account – a password it created by PTAGIS and sent to the supplied email account; the user is displayed a page confirming the new account creation and the password was emailed to them.
Features:
1. User must enter data in all fields in Step 1; fields in Step 2 are optional.
2. Once user presses Continue button on Step 1, input is validated to make sure all required fields are entered and the chosen user name is not already taken; user is directed back to input page with appropriate warning messages displayed in Instruction/Explanation section.
3. If input passes validation in feature #2 – a third validation occurs where the first and last name, organization and phone number are searched to see if user has already created an account. If a match is found – user is prompted and has the choice to login with the existing account or to continue creating new account. This feature will help prevent extraneous accounts.
4. User can select custom email notifications or online newsletter on Step 2 form.
5. User presses Create Account button on the Step 2 form – the account is created and a confirmation page displays new account information and notifies users
50
password will be emailed to the supplied email address and that it is recommended they change the password when they login.
6. Organization field is a drop-down control to avoid having the same organization entered with different spellings or abbreviations. First option in drop-down will be to ‘Add New Organization…’, and when this is selected, the combo-box allows user to edit.
This page attempts to help a user remember their password one of two ways: displaying their password hint or emailing their password to the account’s email address.
Features:
1. User will supply their user name and press Lookup Hint button; if user name is valid - the password hint is displayed.
2. User clicks on Email Password – the email account that is supplied in the account is used to mail the password; a confirmation page is displayed notifying user that the password was successfully emailed.
8.1.3 Privacy Policy
This page displays a privacy policy of any contact information the user enters into the system.
8.2 Home Page
This section provides customizable features, such as saving query definitions, reports and parameters, and data files to a private repository that only a logged in user can view. The home page is accessible once the user logs in, the Logon button is replaced with Home Page and provides the functionality specified below. This section is intended to give the user ‘quick access’ to PTAGIS functionality used commonly by the user; similar to the ‘favorites’ functionality of web browsers.
Features:
1. A greeting will be displayed in the Page Title frame with user’s name to help identify the home page section.
2. Secured features will be available depending upon user’s security role. For instance, if they are a tag coordinator they will have extended settings in the Edit Account section.
8.2.1 My Messages
This subsection displays a list of all PTAGIS generated messages (figure 37) – such as the completion of a scheduled query, user exceeding disk quota, and completion of a PTAGIS request. Most of the messages are also emailed to the user. The general purpose of the My Messages queue is to guarantee message notification of related PTAGIS process.
Features:
1. Messages are displayed in their entirety and are usually only a few, terse lines in length. Included with messages are the date and time the messages was received and a source or author (‘From’), such as a process or ‘PTOC admin’.
2. Messages, by default, are displayed in chronological order, most recent first.
3. Users can sort date and source columns.
53
4. General messages displayed News Update frame of 3.0 Advanced Information page are also copied to the user’s personal message page. This will increase the likelihood that users will see the messages if they link directly to their home page.
5. Users can delete selected messages. One or more messages can be selected by clicking on the icon listed to the left of the message; clicking the icon a second time will deselect a message.
6. An auto-refresh mechanism should be implemented for this page so users will see any new, important messages.
7. Some sort of visual indicator should appear on the Page Title of all pages described in this section indicating the user has new messages awaiting them.
Questions:
1. If we choose to keep this section, we need to define a list of all messages/types.
a. This item will be driven by actual implementation of all other processes that communicate messages to the user.
2. Should messages work more like email, where a small subject is displayed and the full message is viewed in a separate window when the message is selected and a View button is pressed? This would allow for more detail in the message without compromising screen real estate.
a. The types of messages are to be determined at implementation time – if they require more real-estate than what can be reasonably shown in a list, this method should be used instead.
54
Figure 37 – Home Messages Wireframe
8.2.2 My Queries
This subsection displays any queries the user designed using the 8.4 Query Builder tool and chose to save the definition of the query to this section. This allows the user to run the query multiple times without having to create it again and again.
Features:
1. Queries are displayed by query name, description, date modified and the next time they are scheduled to execute.
2. Users can sort by clicking on display column in ascending/descending order.
3. User can select a query by clicking on the icon or row containing query name; icon will change display to indicate it is selected; only one query can be selected at a time.
4. Open (or double-clicking a query) will launch the 8.4 Query Builder wizard, displaying all settings for the selected query. The user can modify these settings and overwrite the original query, and/or choose to execute the query from the last page of the wizard.
5. Execute will be disabled if the selected query is already scheduled to run. If it is not scheduled to run, pressing Execute will run the query according to the settings configured in 8.4.4 Execution page of Query Builder. If the execution settings for the selected query are set to ‘Don’t execute this query at this time’, then the query is opened in the Query Builder wizard and the last page of the wizard is displayed by default.
6. Copy function will make an exact copy of the selected query, automatically naming the new query by wrapping original name with ‘Copy [(n)] of <query name>’. If query selected to be copied is scheduled for execution – the copy will also be scheduled using the same execution settings.
7. Rename will prompt the user to rename the selected query. By default original name is displayed in prompt.
8. Delete will purge the selected query from the user’s account and any schedule executions. Any associated Registered Tag groups in the criteria of the deleted query will be unaffected.
55
Figure 38 – Home Queries Wireframe
8.2.3 My Reports
This subsection displays (figure 39) any reports user may have saved to their account from section 4.1 Reports. What is saved is not the actual output of the report, but an instance of the report definition and all parameter input entered by the user. The general concept of this feature is to allow users to quickly run reports for a specific context. The report parameter input must be complete before the report can be saved to a profile.
For example, a user may be monitoring data submission for three interrogation sites; they could save a version of the ‘Interrogation Status Report’ and make two copies - each with a specific site code and a general date range of ‘one month’ or ‘one week’. The user only needs to click on the report link to see this information without having to perform repetitive parameter input each time.
Features:
1. User will supply a name for the saved report, which will be displayed in the report column and the date created and modified.
2. Users can sort by either column in ascending or descending order.
3. Double-clicking a report will automatically open the report for editing.
4. Users can select a report to Open, Execute, Copy or Delete by clicking it once with the mouse – the icon will change to signify that it’s been selected; clicking on
56
it again will deselect the report. Once selected, clicking on the appropriate command button will execute the desired function.
5. If no reports are saved, the main navigation will display simple instructions for saving reports.
Figure 39 – Home Reports Wireframe
8.2.4 My Files
This subsection displays (figure 40) any files the user has created from a query, report or uploaded from their system. When the user creates an account, PTAGIS automatically allocates them disk space to store their files.
Features:
1. Files are displayed by a user defined name, size in kilobytes and date the file was last modified.
2. Users can sort in ascending/descending order by clicking on column headings.
3. User can select one or more files by clicking on the file row or icon – icon will change display to indicate that it’s been selected; clicking on the row again will deselect a file.
4. The first file selected can be displayed by clicking on the View command button – a separate window is launched displaying the contents of the file.
5. Users select one or more files and press the Download command button, a native browser dialog will display allowing them save the files from PTAGIS storage to local disk on their desktop.
57
6. Rename function will allow users to rename the first selected file by prompting them for a new name (default value is existing name).
7. Delete function will delete one or more selected files from the user’s account file system – Disk Quota will be automatically refreshed.
8. Pressing the Upload command will display a native browser dialog to select one or more files to transfer from local disk to PTAGIS storage, using same file name as on local disk.
a. Any naming issues, such as invalid characters or duplicate file name will abort the upload process.
b. All data files uploaded are automatically scanned for viruses.
c. If a potential Upload exceeds Disk Quota space, the user is warned the upload process is cancelled.
9. Disk quota is displayed at bottom of frame; if user exceeds they will have a message sent to them (see 8.2.1 My Messages) and the frame display some sort of indicator. Additionally, the Upload command will be disabled. Default quota size will be determined upon deployment of web site.
10. Users will have to name files using UNIX naming conventions, which are case sensitive.
Questions:
1. Do we want to include folder functionality in this section? We would also have to specify a Move command.
a. No – file names only.
2. Include Microsoft drag-and-drop functionality for uploading/downloading files to and from PTAGIS storage?
a. Yes but not a high priority.
3. Include other file types than ASCII text, such as XML, ZIP, TAR?
a. Yes, not restricted; should store whatever file type a UNIX file system will allow.
4. Automatically convert Unix/DOS files to match target system?
a. If download/ftp command doesn’t do this automatically, we need to implement a mechanism to preserve OS compatibility.
5. Specify an expiration period on all data files? If so, should we adopt a naming convention to file names so users can prevent them from being deleted after a certain date?
a. User should have control over their files, it may be functionality we need to add after deployment based upon usage of this feature, but for initial implementation there will be no automated expiration control.
58
Figure 40 – My Files Wireframe.
8.2.5 My Registered Tags
This portion of the user’s home page (figure 41) provides functionality for managing ‘registered tags’. ‘Registered tags’ are a file of pit tag codes read from a file and tracked in the PTAGIS database and exclusively associated with the user’s account. The user can use a group of registered tag codes as criteria for building a query (see 8.4.2 Criteria for more information).
Features:
1. All groups of registered tag files are displayed in the main frame by name, number of tags and date of last modification. User can sort by any of these fields by clicking the header above (once for ascending, again for descending).
2. User can select one or more files by clicking on the file row or icon – icon will change display to indicate that it’s been selected; clicking on the row again will deselect an item.
3. Double-clicking a registered group will automatically display a viewer of all tag codes contained within group (as if user pressed the View button).
4. The View button will display a secondary window, containing a read-only list of all tag codes associated with the first group selected.
59
5. The Rename button will prompt the user to rename the first group item selected; the default value provided by the prompt is the current name of the group.
6. The Delete button will prompt user to confirm the process – if confirmed, all selected registered tag groups will be deleted from the system. If any of the selected registered groups are associated with criteria for a query – the user will be notified and the process will abort.
7. The Download button will prompt the user for a path on their local system with the browser’s native common dialog, if user proceeds, all selected registered groups will be downloaded to the specified location in ASCII text format using the supplied name and appending a .txt extension.
8. The Upload button (may be drop-down button with two options: local file or My Files) will prompt the user for a file on their local system using the browser’s native common dialog, or allow user to select a file from 8.2.4 My Files. If the user selects a file, the file is uploaded temporarily onto the server and the contents of the file are scanned and any valid tag codes contained within the file are registered as a tag file list. By default, the name of the group is the name of the file selected. The user is notified to the number of tags registered and the interface is refreshed to reflect the new group. The Upload function will use a smart-scan technology that will recognize PTAGIS tagging and interrogation files and extract tag codes from them; otherwise files must have each tag code on a separate line or comma/tab separated.
9. The Copy button will make an exact copy of the selected file and wrap the original name with ‘Copy [(n)] of <query name>’.
10. Union, Intersect and Difference will take two or more selected files and perform the chosen operation upon them, producing a new file with the name of the operation appended to the first file name selected. Union combines files, intersection combines only common tags between files and difference will create a file of all tags that don’t have relative counterpart in all other selected files.
11. Filter Duplicates will take one or more selected files and remove any duplicates tag codes found within each selected file.
12. Disk Quota is monitored to make sure user’s do not overburden the PTAGIS system with files and registered tags. The percentage combines all files and registered tags into a single quota – displayed below the main frame in ‘My Files’ and ‘My Registered Tags’. User can submit a request for more disk quota to the PTOC admin by clicking on the link below (simple mailto link).
13. If user exceeds Disk Quota, the Upload button is disabled and a warning message is displayed below main frame.
Questions:
1. Should a smart-scan be implemented to allow users to register tagging and interrogation files without having to extract the tag codes? The smart scan will perform a pattern search on the entire file and extract any data that appears to match a tag code pattern.
a. Yes, the Upload function will use a smart-scan technology that will recognize PTAGIS tagging and interrogation files and extract tag codes from them; otherwise files must have each tag code on a separate line or comma/tab separated.
60
2. What kind of limits to we need to impose on registering tag files –such as the number of tags allowed? What kind of effect would a large registered tag group have on a database query? Or is the quota limitation enough?
a. To be determined during implementation.
3. Should the Disk Quota combine files and registered tags – or should there be separate quotas for each feature?
a. Yes, registered tags are stored as a disk file, therefore the Disk Quota computation should include these files also.
Figure 41 – My Registered Tags Wireframe
61
Figure 41.a – My Registered Tags Page Layout
8.3 Manage Account
This section provides features for users to maintain their account information, and, if the user has been granted a special security role, they can perform other tasks such as tag coordinators adding users to submit tagging data.
Features:
1. By default, when user selects this command button, the 8.3.1 Account Detail is displayed.
2. Most likely, other subsections will be added here when 7.0 Requests are fully specified.
3. Data Submission link in left navigation will only appear if user is a ‘Tag Coordinator’.
4. Users cannot designate themselves as a tagging coordinator – this is a process regulated by PTSC and PTOC administrator.
62
Figure 42 – Manage Account Flow Chart Diagram
8.3.1 Account Detail
Users can maintain the demographic information associated with their account.
Features:
1. This section contains similar interface as 8.1.1 New Account.
2. As in 8.1.1, users must complete all fields in Step 1 (figure 40); fields in Step 2 (figure 43) are optional.
63
3. Account detail information is stored in PTAGIS Address Book (PAB) structures; email notifications actually add/remove a user from the associated PAB group.
4. Users must click on Continue to perform validation of fields in Step 1 and continue on to Step 2; pressing Update in Step 2 will actually save any modifications and submit an email/message confirmation to the user that account information has changed.
5. Construct policy for exception such that an account has an invalid email address (tracked by server) and an attempt to contact them by phone/mail also fails – their account is deleted by PTOC administrator. Automated functionality shouldn’t perform this task.
6. Organization field is a drop-down control to avoid having the same organization entered with different spellings or abbreviations. First option in drop-down will be to ‘Add New Organization…’, and when this is selected, the combo-box allows user to edit.
7. User will type Email Address twice to make sure there are no typos in this field.
64
Figure 43 – Account Detail ‘Step 1’ Wireframe
Figure 44 – Account Detail ‘Step 2’ Wireframe
8.3.2 Change Password
This feature allows users to change their password for their account access.
Features:
1. User must be logged in to perform this activity.
2. User must supply their original password; retype their new password and include an optional password hint.
3. If new password is accurate and valid, the user is directed to a confirmation page; a confirmation message is sent to their account and emailed.
4. All passwords are input with a ‘*’ character mask.
65
Figure 45 - Change Password Wireframe
8.3.3 Close Account
This feature allows users to close their account. All database settings and files related to the user account will be recycled.
Features:
1. User must read a confirmation message, select a check box and press the Close Account button to initiate purge. Close Account button is disabled until user selects the check box as a safeguard.
2. User cannot undo this operation, however user can request to have account reinstated (see question #1 below).
3. User will be asked to optionally supply a comment for why they are closing this account.
4. Users will be warned not to press their Back button on their browser for any previous pages involving their account will be inactive.
5. Once close process is complete, a confirmation page is displayed and a confirmation message is emailed to the accounts email address. User is considered logged out at this point.
Questions:
1. Instead of closing the account automatically, perhaps we should make the process more manual to safeguard against accidental closures? The user will be notified that their account will expire in 24 hour period after the request – the request is then emailed to the PTOC administrator to manually run a closing process after the elapsed period.
66
a. Yes, the PTAGIS system should disabled the account but not delete for an extended period of time. This will allow user to reinstate the account by contacting the PTAGIS administrator without losing any content.
Figure 46 - Close PTAGIS Account Wireframe
8.3.5 Privacy Policy
This page displays a privacy policy of any contact information the user enters into the system.
8.4 Services
This section provides PTAGIS services to the user that is logged in. Some services require the user to have additional security roles. The services described in this section replace the ‘Requests’ functionality specified in the first draft of this document. User must create an account to access these features.
When the user selects the Services command in their account, an Overview Page is displayed describing the services listed in the left frame. If user doesn’t have access to a particular service, the command will be disabled and the description will indicate the user does not have the required access.
67
8.4.1 Tag Projects
This service provides users granted with a ‘project sponsor’ role the ability to manage project information and user access for 8.4.2 Tag Distribution Request services. When the user clicks on this service, a list of all projects assigned to them in the PTAGIS Tag Distribution and Inventory system (TDI) are displayed. As shown in figure 48, a project sponsor may be assigned multiple projects to manage.
Figure 47 – Project Sponsorship Hierarchy
Features:
1. PTAGIS Administrator will grant/revoke the ‘project sponsor’ role to specific user accounts and project sponsors, they will also be assigned to one or more TDI projects.
2. Project sponsors use this service to sponsor Tag Coordinators (other user accounts) to access 8.4.2 Tag Distribution Request service for one or more TDI projects.
3. PTOC will populate data structures to support these services with current project sponsors, TDI project and tag coordinators relationships from TDI system when web site is deployed.
4. If the project sponsor is assigned to more than one TDI project, the command will display multiple projects under the Tag Projects command in left frame (figure 48), otherwise the command will not list additional projects underneath.
5. User can Print the summary information as a report.
6. All summary Project Summary information is read-only.
7. The Project Summary tab is displayed first by default.
8. This service could be expanded in the future with an additional tab for Reports that allow the user to view budget/distribution information that may be too confidential to be accessed in 4.1.1 Interactive Reports.
68
Figure 48 – Project Summary Wireframe
Figure 48.a – Project Summary Page Layout
69
8.4.1.1 Tag Project Sponsorship
This feature allows the user to grant access to the web-enabled 8.4.2 Tag Distribution Request service. Features:
1. Project Sponsor selects a tag coordinator from the list on the left, presses the Add button and the selected name is removed from the left list and put into the sponsorship list on the right.
2. The Update command will save any additions or removals from the sponsorship list.
3. All sponsored tag coordinators will have access to the tag distribution service on this web site.
4. If user modifies the sponsorship list and attempt to navigate off of the page, the user will be prompted to ‘Save Changes?”.
Figure 49 - Project Sponsorship Wireframe (tab frame only) 8.4.1.2 Tag Project Contact Information
This feature allows the project sponsor to keep TDI project information up-to-date.
Features 1. The required fields (those marked with a *) must be completed before the
Update command will save any changes. 2. The Organization field is a drop-down control that initially does not permit
user to type new organizations. The first item in the list is ‘<Add New Organization>’ and when selected, the control changes context and permits user to type a new item into the list. This is intended to promote consistency.
3. If user modifies the sponsorship list and attempt to navigate off of the page, the user will be prompted to ‘Save Changes?”.
70
Figure 50 – Project Contact Information Wireframe (tab frame only)
8.4.2 Tag Distribution Request
This service provides a web-enabled interface for tag distribution for tag coordinators and project sponsors. The project sponsors can request tags by default, however, tag coordinators must be granted access by the project sponsor, specified in 8.4.1.1 Tag Project Sponsorship. Features:
1. Only projects granted to tag coordinator will be displayed in Tag Project drop-down control. When user selects a project, the drop-down list will have two columns: project # and description (up to 75 characters), when project is selected, only the project # is displayed in control.
2. By default, tag coordinators contact information is used as default for recipient/shipping information. However, the tag coordinator can hit the Clear command and enter another name/shipping address. The recipient/shipping information does not need to be tag coordinator, or even a user with a PTAGIS account.
3. The Organization field is a drop-down control that initially does not permit user to type new organizations. The first item in the list is ‘<Add New Organization>’ and when selected, the control changes context and permits user to type a new item into the list. This is intended to promote consistency.
4. Fax and Email fields are not required; all other fields are required. Amount field must be in increments of 100, user will be asked to supply a different value if not.
5. The Submit button will validate input, if valid the distribution request is submitted to PTAGIS for processing. The user will then see a printable confirmation page with distribution request information and an assigned DRF #. The tag coordinator will also receive this confirmation by email (and CC’d to email address on this form if supplied and different from Tag Coordinators). and as a message to the tag coordinator’s account.
6. Tag Coordinator and any user supplied email address will receive notification from internal PTAGIS systems when their request has been processed. The Tag Coordinator will also receive distribution process messages to their account.
71
Figure 51 – Tag Distribution Request Form Wireframe 8.4.3 Data Submission Settings
This section provides functionality from the Telnet application such that any user granted the ‘Data Coordinator’ role can manage additional data contributors that are allowed to submit tagging data under their coordinator id, or can submit interrogation data for any site.
Features:
1. This management tool (Figure 52) is only accessible by a user with a PTAGIS account that has been granted ‘Data Coordinator’ role by the PTAGIS administrator.
2. Data coordinators and can add or remove email addresses that can submit tagging or interrogation data. The email addresses do not have to be already defined in a PTAGIS user account.
3. A coordinator can adjust how much feedback they’ll receive from PTAGIS, in the form of messages and email, when they submit tagging or interrogation data themselves.
4. A coordinator can adjust how much feedback each contributor will receive (via supplied email address) as well which feedback will be CC’d to them.
5. A confirmation email will be sent when the coordinator saves any changes to this section. If a new contributor is added or removed, the corresponding contributor’s email address will also receive confirmation email.
72
6. Confirmation email will be monitored by PTOC admin or an automated process so that data coordinators are notified of any invalid email addresses.
7. Page title frame should visually indicate the logged in user is a tagging coordinator and display coordinator ID.
8. Coordinator cannot edit an existing contributor – they must remove and add them again to modify feedback or email address.
9. Contributor list allows multi-selection; icon indicates selection mode.
10. If coordinator users the same email address for two or more contributors, first input wins.
11. List is displayed in order of input and cannot be sorted.
12. When coordinator presses Save Changes, only changes about feedback notification are committed to database.
13. Add command button will display a secondary page (Figure 53) to input name, email address and feedback information.
14. Remove command button will remove one or more selected data contributors.
Questions:
1. Do we need to design this page to allow users to submit interrogation files (per Dave Marvin’s suggestion)? If so what are the requirements.
a. Yes, the interface should accommodate both types of data contribution, tagging and interrogation.
2. Are the feedback notifications types consistent with existing FDVL functionality?
a. According to Doug Clough, they are, however some modifications may need to be made to existing process to support this interface.
73
Figure 52 – Data Submission Management Wireframe
Figure 53 – Add Data Contributor (frame only)
8.4.4 New Validation Code Request
This service allows users to request a new validation code, which include new tagging, release and interrogation sites. The request will gather necessary information from the
74
user and submit it to an internal process for committee approval. The user is informed of how the process works and they are notified via email and account message with the status of their request. Features:
1. User first selects the type of new code they are requesting – the selection will drive the rest of the interface. Table below describes the types of validation codes the user can select.
2. If user selects a different type of code, the interface is refreshed for the new interface, any input will be disregarded.
Figure 54 – New Validation Code Request Wireframe Types of Validation Codes
Data Source Description Interface Capture Method 8.4.4.1 Conditional Comment 8.4.4.1 Hatchery 8.4.4.1 Organization 8.4.4.1 Rearing Type 8.4.4.1 Run Code 8.4.4.1 Species Code 8.4.4.1 Verbose SRR 8.4.4.1 Tagging Coordinator 8.4.4.1 Tagging Method 8.4.4.1 Tagging Site 8.4.4.2 Release Site 8.4.4.2 Interrogation Site 8.4.4.3
75
8.4.4.1 General Validation Codes
When the user selects a general type of validation code, the interface is described below in figure 55. Features:
1. User must complete all fields. 2. When user Submits the request, the site code is verified that it doesn’t
already exist – if it does the user is warned and must enter another site identifier.
3. When code is successfully submitted, the user’s account information and code information is submitted to an internal process for committee review; the user sees a confirmation page that the code was successfully submitted with details about the approval process.
4. The user is emailed (also message sent to account) informing them of events during the approval process.
Figure 55 – General Validation Code Request Wireframe (frame only) 8.4.4.2 Tagging and Release Site Codes
When the user selects a general type of validation code, the interface is described below in figure 56. Features:
1. Release Site check box will enabled subordinate controls based upon selection.
2. User must complete all enabled fields. 3. When user Submits the request, the site code is verified that it doesn’t
already exist – if it does the user is warned and must enter another site identifier.
4. When code is successfully submitted, the user’s account information and code information is submitted to an internal process for committee review; the user sees a confirmation page that the code was successfully submitted with details about the approval process.
5. The user is emailed (also message sent to account) informing them of events during the approval process.
76
Figure 56 – Tagging and Release Site Validation Code Request Wireframe (frame only) 8.4.4.3 Interrogation Sites
This interface prompts the user to complete fields to initiate the approval process for a new interrogation site. Features:
1. User must complete all fields. 2. The user must attach a map of their proposed interrogation site. 3. When user Submits the request, the site code is verified that it doesn’t
already exist – if it does the user is warned and must enter another site identifier.
4. When code is successfully submitted, the user’s account information and code information is submitted to an internal process for committee review; the user sees a confirmation page that the code was successfully submitted with details about the approval process.
5. The user is emailed (also message sent to account) informing them of events during the approval process.
77
Figure 57 – Interrogation Site Request Wireframe (frame only)
8.4.5 Register Test Tags
This service allows any user to register test tags with PTAGIS. The user provides a list of tag codes with additional information (figure 58), the codes are audited in the PTAGIS database and the result of the audit is displayed to the user. The user confirms the audit and the request is sent to PTAGIS for processing. Features:
1. User attaches a file (one tag code per line) from their local file system. 2. The user must select one of two types: ‘Stick Tags’ or ‘Timer Tags’. 3. ‘Timer Tags’ require the user to select an interrogation site to associate with. 4. The user presses Submit button and the attached file is loaded to the PTAGIS
system an audited for existing mark/recapture and interrogation information. This information is displayed to the user.
5. The user presses the Submit Request button on the Confirmation Page and the request, user account information and audit are sent to PTAGIS for internal processing; the user is notified via account message and email of process status.
78
Figure 58 – Register Test Tag Service WireFrame
8.4.6 Clip Files
This service allows any user with an account to download clip files from the PTAGIS system. When PIT Tags are distributed from PTAGIS, users are given data files that match each bag/box of tags and their contents (tag codes). Clip files are used for validation during tagging process. Features:
1. Type of Search can be ‘Bag Code’, ‘Tag Code’, ‘Project Number’, ‘DRF Number’, ’Alt Distribution Source’.
2. Each time user presses Search button, the results are cleared and any corresponding clip files from the search are displayed in the Results frame.
3. User can select one or more files in Results window, pressing the Download button prompt the user for a local directory and then will transfer the ASCII text files.
4. Mouse-over causes clip file in results to display hyper-link – when clicked the hyperlink displays a pop-up window with all tag codes contained within selected clip file.
79
Figure 59 – Clip File Request Service Wireframe.
8.5 Query Builder
This is an ad hoc, data extraction tool designed to replace the functionality of the PTAGIS telnet application. This tool provides a simple interface for users to extract the exact data they need from the PTAGIS database and save it to a file or display it in their browser. The wizard style interface provides the user with a step by step guide for building and executing a query. The overall goal of this tool is to increase the number of PTAGIS data consumers by making data extraction a simple and useful process.
Features:
1. Simple yet feature-rich interface allows advanced and novice users to create their own query. Query Builder’s primary emphasis is on data extraction to a file for analysis from another toolset; simple data analysis, aggregation and reporting features are also available, but are not the primary focus of this tool.
2. Because a query can consume a large amount of resources, the Query Builder tool is only available to users that are logged in so that PTAGIS can monitor and identify activity by user.
3. Queries can be saved to the user’s account to be run again and/or modified. When editing an existing query, if the data source is altered (from 8.5.1 Step 1: Data Source) all subsequent query settings are automatically reset.
4. The Page Title frame displays either ‘New Query’ or the name of the existing query.
5. Query Wizard’s interface is independent of the data used to generate the queries; the PTAGIS database, schema and metadata can change over time without modification of this design.
The Query Builder wizard is comprised of the following pages:
80
8.5.1 Step 1: Data Source
The user designates which data source to generate their query from. Data sources provide logical views of the PTAGIS data set, such as ‘Tagging/Release Header’, “Tagging Details’, ‘Mortalities’, ‘Recaptures’, etc. Once a data source is selected, the user then selects one or more fields to return in their query.
Features:
1. All Data Sources are listed in a drop-down at the top of the page. When a particular Data Source is selected, all fields contained within the data source are displayed in the Available Fields.
2. If a subsequent Data Source is selected, the user is warned that all settings in the existing query will be reset. If user continues, all settings on this page and all others are reset as if the user is creating a new query.
3. The user must select one or more fields by moving them from the Available Fields to the Selected Fields list. The field order is preserved in the query output. Only a single instance of a field can exist in either list.
4. Clicking More Info will display detail about the selected data source and all fields from the online help.
5. The Next and Finish command are only enabled when there is a Data Source selected and at least one field in the Selected Fields list; Next button will take user to the next step in the query builder process; Finish button will take the user to final step of the query builder process, accepting all default settings on pages in between.
6. Cancel button ignore any changes to the existing query and starts over with a new query (no Data Source will be selected). If user was editing an existing query, the query is reloaded with original settings from last time it was saved, any changes are discarded.
81
Figure 60 – Query Builder Data Source Wireframe
Data sources defined:
Data Source Description Tagging/Release Hdr Tagging Details Interrogation Summary First Interrog Main Interrog Site Detail Recapture Mortality CEA Adult Rice Island Recoveries What else????
8.5.2 Step 2: Criteria
The user defines search criteria (WHERE clause of an SQL statement) on this page. The input method is patterned after a generic ‘English Style’ query, which can be used to create very complex criteria while remaining independent of the data. Features:
1. The Clear button will reset all conditions from the input frame. 2. If user presses Back, Next or Finish buttons and any conditions are not valid or
complete - the user is warned and cannot continue the operation until the all criteria conditions are complete.
82
3. Cancel button ignore any changes to the existing query and starts over with a new query (no Data Source will be selected). If user was editing an existing query, the query is reloaded with original settings from last time it was saved, any changes are discarded.
Figure 61 - Query Builder Criteria Wireframe
Defining Search Criteria
Individual lines of criteria are called Elementary Conditions, such as 'Records where Conditional Comment contains M'. The sentence that logically combines one or more Elementary Conditions is called a Complex Condition, such as 'Select records where any of the following apply'. A search can have one or more Complex Conditions. To add or delete a condition, the user clicks the button next to the selected row and the following drop-down menu (figure 48) appears below the button:
Figure 62 – Drop-down menu for adding and removing criteria conditions
The English-style criteria displayed in figure 61 will generate the following SQL ‘WHERE’ clause:
83
(TagDate BETWEEN DATE(1/1/2001) AND DATE(1/1/2002)) AND (ObsSite = ‘GRA’) AND (CoordID = ‘DPM’ OR CoordID = ‘AAB’)
8.5.2.1 Elementary Conditions
When creating an Elementary Condition, there are three components of the condition that must be defined: Field, Comparison and Value.
Figure 63 – Components of an Elementary Condition
Clicking on the Field modifier will display a drop-down list of all available fields from the selected data source. The Comparison modifier defines how the Field and Value modifiers will be related. This modifier can be 'Equal', 'Greater', 'Less', 'Greater or Equal', 'Less or Equal', 'Not Equal', 'Is Empty', 'Is Not Empty', 'Contains', and 'Starts With'. The last two modifiers, 'Contains' and 'Starts With', can only be used with text fields. Fields of type date have a special ‘Is Between’ comparison operator; and the field defined as a PIT Tag Code has a special ‘In’ operator defined below.
Field Data Type Available Comparisions Text 'Equal', 'Greater', 'Less', 'Greater or Equal', 'Less or
Date 'Equal', 'Greater', 'Less', 'Greater or Equal', 'Less or Equal', 'Not Equal', 'Is Empty', 'Is Not Empty', ’Is Between’
Number 'Equal', 'Greater', 'Less', 'Greater or Equal', 'Less or Equal', 'Not Equal', 'Is Empty', 'Is Not Empty',
Lookup Code ‘Equal’, “Greater’, “Less’, ‘Greater or Equal’, ‘Less or Equal’, ‘Not Equal’, ‘Is Empty’, ‘Is Not Empty’, ‘Contains’ (for conditional comments)
PIT Tag Code ‘Equal’, ‘Contains’, ‘Starts With’, ‘In’ Boolean ‘Is True’, ‘Is False’ ‘Is Empty’, ‘Is Not Empty’
If the Comparison modifier is set to something other than 'Is Empty' or 'Is Not Empty', then the user must supply a Value. A list box will automatically appear so they can choose an item from pre-defined field domains. For fields without pre-defined domains of values (such as the Length, Weight, and Textual Comments fields) they can key in the comparison value. For text fields, they can use a "%" wildcard to match any group of characters or a "_" wildcard to match any single character within the text value. If the field type is of date – the user can either manually type the date or press the drop-down button to view a calendar window and select a date from it. If the field is date/time – then only the date portion of the field is input with a default time of 12:00 PM (PST). Additionally, date fields can have generic values such as ‘last week’, ‘entire year’, ‘yesterday’ and so forth so that queries can be run subsequently over time and not have to be modified each time. In the special case the field is of type ‘PIT Tag Code’ and the comparison operator is selected as In, when the user presses the drop-down button, all tag groups currently
84
registered in the user’s account will be displayed for selection. User can only select one tag group to associate per criteria. Questions:
1. What functionality do we need to specify for searching conditional comments (if implemented in PTAGIS3)?
a. To be determined at implementation, PTAGIS3 will be moved to new hardware platform and then tuning/structural changes will come afterwards. To early to specify this functionality.
8.5.2.2 Complex Conditions
A Complex Conditions determines how all subordinate elementary conditions are logically connected to produce the result set. When defining a Complex Conditions, the user clicks on the blue hyperlinked word to select a modifier as listed in table below:
Logical Operator Description Any Any one of the elementary conditions is true. All All of the elementary conditions must be true. None None of the elementary conditions are true. Not All At least one of the elementary conditions is false.
Note: Complex Conditions can be nested (a Complex Condition containing another Complex Condition as a sub-condition as shown in the example query in figure 61).
85
8.5.3 Step 3: Summary
This page of the wizard allows users to sort the output or to calculate a summary or aggregate for each field.
Features:
1. Only the fields selected from 8.5.1 Data Source are displayed here. Removing a selected field in the Data Source will remove the field from this section and any associated summary settings.
2. Fields above have higher precedence in sorting order.
3. Some aggregate functions do not apply based upon a field’s data type; these are identified with a disabled checkbox.
4. All input on this page is optional.
5. If no summary functions are selected in any field, the query produces detail for all records and all fields; otherwise, the query produces summary results (GROUP BY).
Questions:
1. What are the specific Ingres rules for aggregation of each data type?
a. Rules for determining aggregates for each data type can vary among versions of Ingres. This functionality will be further defined at implementation with the latest production version of the Ingres database.
86
Figure 64 – Query Builder Summary Wireframe
8.5.4 Step 4: Schedule
This step in the query builder process allows the user to schedule the execution of the query on a particular date and time. Scheduling a query does not guarantee the query will be completed at that time, the scheduling of a query is dependant upon existing load on PTAGIS server. In addition, the query can be specified to repeat execution over a period of time. If user does not schedule query, the query will be executed on-demand.
Features:
1. If user checks Schedule Query option, the date input control and Repeat Execution option becomes enabled.
2. Both date input controls allow user to type in a valid date and time, or select a date from the drop-down calendar control. Default dates and time are current date and 8 PM PST.
3. If the user selects Repeat Execution the query will be executed on a periodic basis – Day, Week, Month Year, specified by the Every input control.
4. Increment File Name will append a unique, numeric identifier to the end of the file name selected in 8.5.5 Finish so that repeated executions don’t overwrite the same output file.
5. Until allows the user to specify a valid date and time to stop the repeated execution. This field is optional.
6. Schedule date must be greater than the current date and time plus one hour. All dates and time are PT (Pacific Time).
7. The stop date must be greater than the schedule date by at least one period; query must be executed at least once or the settings are considered invalid and the user cannot proceed to the next step.
This is the final step in the Query Builder process.
Features:
1. The user must supply a unique Query Name. The name will be used to identify the query throughout the rest of the web site.
2. The user can supply an optional Description of the query. This description is displayed next to the name of the query in 8.2.2 My Queries listing.
3. File Name specifies an output file stored in 8.2.4 My Files area that will contain all of the results of the query when executed. If the file name already exists, it will be overwritten each time the query is executed.
4. File Type specifies the type of output file that will be created when the query is executed:
File Type Extension Description Text txt The results are saved to an ASCII text file in a
human-readable, tabular format. Comma separated value
csv The results are saved to an ASCII text file with each field separated by a comma and each row delimited by a CRLF.
XML xml The results are saved in an xml formatted file, complete with DTD schema description.
HTML htm The HTML used to display the results is instead saved to a file.
88
5. If Include Header option is selected, the output file will include header names over each column. XML files automatically include header names regardless of this setting.
6. If Include Footer option is selected, the output file will include a footer section at the end of the query output to signify the query has completed successfully and all output is included in the file. The footer will include an EOF marker date/time stamp when the query was completed.
7. If Include SQL in Footer option is selected, the SQL text from the resulting query is displayed in the footer section.
8. View Statistics command allows users to see a pop-up window of statistics for their query, such as an estimate of the amount of time and number of rows when executed, as well as the SQL text of the query built.
9. Statistics for each query are pre-generated whenever user enters the Finish page, these statistics are logged so PTAGIS administrator and review the type of queries generated by users and strategize scaling/tuning opportunities for types of data accessed.
10. Since stats are pre-generated at this point, the user is alerted to a query that will consume large resources and/or return large amount of results (long execution time). They may be forced to schedule the query instead of executing on-demand; Save and Execute would be disabled in this case.
11. Preview command will display a second web browser with HTML report format of the results of the query. Only a subset of the results will be displayed (TOP N) so page is rendered quickly.
12. Save Only command will save the query to the user’s account, but will not execute (or schedule) the query. User can edit or execute the query upon demand from 8.2.2 My Queries.
13. Save and Execute (Schedule) command will save the query to the user’s account and execute it on-demand. A confirmation page will be displayed informing the user the query has been executed and provide a link to 8.2.1 My Messages so user can monitor messages as query execution process is running. If the query has been marked for scheduling (8.5.4 Step 4: Schedule), the text of the command will read Save and Schedule, and instead of execution on-demand, the query is scheduled to run at the time specified. A confirmation page will be displayed informing the user the query has been scheduled for a date/time and if it has been schedule for repeated execution; and provide a link to 8.2.1 My Messages to monitor events.
14. Save commands are only enabled if user has entered a valid Query Name, File Name and File Type.
89
Figure 66 – Wireframe of final step in query builder process
8.6 Logout
This feature allows a user to logout of their home page – for whatever reasons. The user is presented a confirmation that the logout process has completed and the Home Page button toggles back to Logon functionality described in 8.1 Logon.
Features:
1. Pressing Logout is immediate and without confirmation. The user can log back into PTAGIS using the Login function.
2. Logout may terminate some processes that have yet to complete – refer to specifications in 8.4.4 Execution for more information.
90
Figure 67 – Confirmation Message of Logout Function
9.0 Contacts
This section of the PTAGIS web site will provide the user information for contacting various PTAGIS personnel, as well as feedback mechanisms for technical support and general opinions. When the user clicks the Contact button in the main navigation section, the 9.1 Contact page (figure 68) is displayed by default.
9.1 Contact Information
This page (figure 68) displays general contact information about PTOC personnel and describes the general relationship between PTAGIS, PTOC, PSMFC, PTSC and Gladstone and Kennewick offices.
Features:
1. All names posted are actually mailto: links and should be framed with address and phone numbers.
2. Design of this page should guide users to contact the appropriate personnel given their task.
Questions:
1. Whom do we want listed in the contacts? BPA, PTSC, PSMFC?
91
a. Add Data Coordinators, Project Coodinators, Tag Coordinators, Projects/COTR.
2. Can we describe the PTAGIS project and related entities pictorially?
a. PTOC is now referenced as PTAGIS (Perception, Tone and Guidelines). Display illustration of PSMFC relation to PTAGIS and other projects.
Figure 68 – Contact Information Wireframe
9.2 Technical Support
This feature allows users to report bugs or problems with web site functionality (and others) by filling out an online form.
Features:
1. Online form guides users to supply more information about their problem than they might have if just sending email.
2. Once the form is submitted, a confirmation page is displayed indicating PTOC has received their request and will reply promptly.
3. All technical support submittals are stored in a defect tracking database, making technical support easier to manage for PTOC personnel. A Knowledge Base feature may be available using this tracking database in the future.
4. Technical support requests have the following categories:
a. PTAGIS Web Site
92
b. PTAGIS Data
c. PTAGIS Requests
d. PTAGIS Software including P3, MiniMon
e. PTAGIS Operations including DGE, ADE
5. This feature is for submittal only; users cannot review past technical support issues.
6. If user has cookies enabled, user contact information is stored and provided as a default for the next submittal.
7. Users can attach a file from their local system to the report.
Figure 69 – Technical Support Request Wireframe
9.3 General Feedback
This part of the contact section provides users with an online survey and free-form input to provide user feedback about PTAGIS and related all related technologies and operations.
Features:
93
1. Provides a survey of general questions to provide most important feedback from users up front, however user input is optional.
2. Provides a text box at the bottom of the form for users to supply specific feedback.
3. All feedback from users is anonymous, and should be stated so at the beginning of the form.
Questions:
1. What survey questions should be up front to help us realize our goals?
a. To be determined at implementation; depends upon overall web site functionality.
2. For non-anonymous feedback from users, should we direct them to PTAGIS Forums (web-enabled, PTAGIS newsgroups of various topics, functionality of which is described in 4.4.7 Site Events)?
a. Added 9.4 PTAGIS Forums.
9.4 PTAGIS Forums
Provide the PTAGIS research, analysis, and management community with a tool to publicly exchange information pertaining to PIT tag-related activities in the Columbia Basin. A previous implementation used a CGI-forum/newsgroup format. While it should not be necessary to moderate any of these categories, the capability and methodology should be addressed Suggested forum categories include:
• Data Analysis (survival studies, sampling/survey issues, predation recoveries, etc)
• interrogation site facility ops (outside of PIT tag data collection) • PTAGIS data management/maintenance issues • PTSC • APTOC • SbyC topics • P3 help • MiniMon help
Questions: 1. Isn’t this functionality described as ‘Content Management System’ in industry
standards?
9.5 Privacy Policy
This page should be stated wherever we collect personal information about a user.
94
10. Help
This section contains online help for the PTAGIS web site. In addition, the user can Search the website or view/navigate the structure of the web site using the Site Map feature. Because the online help will display in the current browser window (side navigation pane will be overwritten), when the user presses the Help button on the main navigation window, an overview page (figure 70) is displayed describing the features in this section. This web site has ‘context-sensitive’ help, which means if the user presses a Help button displayed within the content of a web page (not on the main navigation) a second browser window will display help in context of that particular content. For example, if the user selected a particular report in section 4.1 Reports and pressed a Help button next to the report’s description text – a second window will display information about that particular report from within the online help document. In contrast, when the user clicks the Help button in the main navigation, they are sent to the page below.
Figure 70 - Help Overview Wireframe.
10.1 Online Help
This feature displays the entire, web-enabled user documentation of the PTAGIS website. When the user selects Online Help in the left navigation pane, the existing browser window will contain the online documentation – the left navigation pane in figure 53 will be replaced with the table of contents of the online help system as shown in figure 54. Users will have to use their browsers Back button, or Help button to navigate to other functionality described in this section. For an example of online help – refer to P3 Online Help.
Features:
1. Displays a table of contents that allows the user to read the online help document like a book.
2. Displays a keyword index to help users jump to certain topics, users can type in letters to scroll keyword list.
3. Allows users to perform a full-text search on the entire document, results are displayed below search clue.
95
4. Two panel construction – left panel contains features 1-3, separated by a tab control; right panel contains content of selected topic.
5. Main navigation is visible when online help is displayed.
Figure 71 – Online Help Wireframe
10.2 Search
This feature provides full-text searching of the entire PTAGIS web site and related documents. The user enters one or more keywords, presses the Search button and all related documents and files are displayed in a hit-list within the browser, sorted by relevancy. User can open documents or files by double-clicking the item in the search results.
Features:
1. The following sources are available for full-text searching: 6.1 Documents, 6.2 Newsletters, 4.4.4 Site Data, 4.4.7 Site Events, 9.4 PTAGIS Forums.
2. This feature provides a powerful search mechanism not currently offered by the PTAGIS system that allows users to search for specific text within messages and notes contained in tagging files. Additionally, the user can easily search on a particular tag code to reveal all data files that include that tag code.
3. Whenever a document is published to the PTAGIS website – it is also sent to the full-text search engine so that any visible documentation within the PTAGIS website can be searched upon by the user.
4. PTOC will have to provide automated processing of existing and new data files to update the full-text search engine.
5. Because PTAGIS website is primarily data-driven, it does not make sense to provide web site content for full-text searching.
96
6. User’s search clue is displayed at the top of the result list.
10.3 Site Map
This feature displays the skeletal diagram of the entire PTAGIS web site. Users can see a big-picture of the organization of the site and navigate by clicking on a page within the site. The diagram will look similar to the Site Map displayed at the begging of this document.
