Exhibit_C.pdf
PDF 8 MB Posted
- Solicitation number
- 0000039898
- Issued by
- California
About this file
This is a Functional Design Document for the Recreational Fishing Regulations (RFR) Database and Content Management Application Redesign Phase 2a, developed by the California Department of Fish and Wildlife (CDFW). The document, approved on August 19, 2024, by the Fisheries Branch, Marine Region, and IT Systems Branch, comprehensively defines the objectives, scope, and functional requirements for enhancing the current RFR database and associated content management application to support a future mobile application that will provide real-time recreational fishing regulation information for any location in California. The application encompasses eight primary modules—Species, Species Groups, Take Methods, Features, Regulations, Rules, App Viewer, and Reports—with distinct user roles (Staff/General User, Editor, and Admin) governing access and functionality across these modules. The system integrates with ArcGIS Server to manage spatial data for Marine and Inland fishing locations and features, with the RFR database now accommodating Geographic Information Systems (GIS) data to associate fishing regulations with geographical features.
The document specifies comprehensive functional requirements including user interface standards aligned with California's Web Template specifications and the Orange County theme, content management capabilities with advanced search, filter, and download functions across all modules, user authentication through Microsoft Entra ID, soft delete functionality for data management, and role-based access control implemented through Microsoft Entra ID application roles. Key modules include Regulations and Rules with add, edit, and soft delete capabilities restricted to Editor and Admin users; Species, Species Groups, and Take Methods requiring SQL scripts for data management by the DTD Marine/Fisheries Unit; and App Viewer enabling location-based access to fishing regulations through map-based navigation. The system implements comprehensive audit trails recording Last Updated User ID and timestamps in the format "User ID | MM/DD/YYYY HH:MM AM/PM PST," with initial data load responsibilities assigned to Ravacons and ongoing support transitioning to database administrators. Testing and quality assurance follows a phased approach including unit testing in developer environments, integration testing in the DEV environment, and user acceptance testing in the TEST environment, with the Functional Design Document serving as the user reference manual and a complementary Technical Design Document serving as the staff reference manual for maintenance and support.
View the file
Other files
| File | Type | Posted |
|---|---|---|
| Exhibit_1_-_CDFW_RFR_Requirements.docx | DOCX document | |
| Exhibit_A.docx | DOCX document | |
| Exhibit_B.docx | DOCX document | |
| Attachment_B_-_RFI_Response_Checklist.docx | DOCX document | |
| Exhibit_E.xlsx | XLSX spreadsheet | |
| Attachment_A_-_Vendor_Questionnaire.docx | DOCX document | |
| Exhibit_D.pdf | ||
| RFR_Request_For_Information__RFI_.docx | DOCX document | |
| Exhibit_F.docx | DOCX document |
On GovTribe
Work with this file
- Download the original file
- Contacts named in this file
- Similar government files
- Ask GovTribe AI about this file
Text version
Recreational Fishing Regulations (RFR)
Database & Content Management Application
Redesign
RFR Phase 2a
Functional Design Document
Docusign Envelope ID: C3C59EA3-9982-49A7-9DD1-5B141C1E966D
Page | 1
Table of Contents
1. Version History
2. Document Approval
3. Introduction
3.1 An Overview of the content management web application
3.2 The purpose and objectives of the document
4. User Roles and Permissions
5. User Interface (UI) Requirements
6. Content Management
6.1 Species
6.1.1 Overview
6.1.2 Navigation
6.1.3 Content
6.1.4 Search
6.1.5 Download
6.1.6 Columns
6.1.7 Filters
6.1.8 Pagination
6.1.9 Actions
6.1.9.1 View Species
6.2 Species Groups
6.2.1 Overview
6.2.2 Navigation
6.2.3 Content
6.2.4 Search
6.2.5 Download
6.2.6 Columns
6.2.7 Filters
6.2.8 Pagination
6.2.9 Actions
6.2.9.1 View Species Groups
6.3 Take Methods
6.3.1 Overview
6.3.2 Navigation
6.3.3 Content
6.3.4 Search
Page | 2
6.3.5 Download
6.3.6 Columns
6.3.7 Filters
6.3.8 Pagination
6.4 Features
6.4.1 Overview
6.4.2 Navigation
6.4.3 Content
6.4.4 Search
6.4.5 Filters
6.4.6 Pagination
6.5 Regulations
6.5.1 Overview
6.5.2 Navigation
6.5.3 Content
6.5.4 Search
6.5.5 Download
6.5.6 Columns
6.5.7 Filters
6.5.8 Pagination
6.5.9 Actions
6.5.9.1 Add New Regulation
6.5.9.2 Add Child Regulation
6.5.9.3 View Regulation
6.5.9.4 Edit Regulation
6.5.9.5 Delete Regulation
6.5.9.6 View/Activate Deleted Regulations
6.6 Rules
6.6.1 Overview
6.6.2 Navigation
6.6.3 Content
6.6.4 Search
6.6.5 Download
6.6.6 Columns
6.6.7 Filters
6.6.8 Pagination
6.6.9 Actions
Page | 3
6.6.9.1 Clone/ View/ Edit/ Delete (Rule icons)
6.6.9.2 Delete Rules
6.6.9.3 View/Activate Deleted Rules
6.7 App Viewer
6.7.1 Overview
6.7.2 Navigation
6.7.3 Content
6.7.3.1 Rules View
6.7.3.2 Features View
6.7.4 Search
6.7.5 Download
6.7.6 Pagination
6.8 Reports
6.8.1 Regulations Report
6.8.1.1 Overview
6.8.1.2 Navigation
6.8.1.3 Content
6.8.2 Rules Report
6.8.2.1 Overview
6.8.2.2 Navigation
6.8.2.3 Content
7. Search and Navigation
8. User Registration and Authentication
9. Content Versioning and Revision History
10. Permissions and Access Control
11. Data Management
12. Integration with External Systems
12.1 ArcGIS Server
12.2 Future CDFW Mobile App
13. Testing and Quality Assurance
13.1 Unit Testing
13.2 Integration Testing
13.3 User Acceptance Testing (UAT)
14. User documentation
Page | 4
1. VERSION HISTORY
Version Date Author Key Differences v2 07/26/2024 Anil Chalasani All mockups and wireframes have been replaced with actual screenshots of the application and its features. These screenshots are highlighted to help users easily follow the documentation and identify the features and their locations within the application.
v1 11/28/2023 Hemanth Balasundaram This comprehensive functional design document is a consolidated and refined version of the approval documents that were earlier reviewed & approved by the product owners.
The document is developed to also serve as a user reference manual and may be further updated as needed towards the end of the project to reflect the final deployed version.
Note:
The marked-up version of this document with the review comments, notes/highlights for later follow up is saved in the Archive folder.
https://cdfw.sharepoint.com/:f:/r/teams/Project-RFMApp-P1/Shared%20Documents/Phase%202a/Requirements/Functional%20Design%20Document?csf=1&web=1&e=3rPWhh
Page | 5
2. DOCUMENT APPROVAL
CDFW Branch Name Title Date Signature
Fisheries Branch Marguerite McCann Fisheries Branch
Product Owner
Marine Region Paulo Serpa Marine Region
Product Owner
IT Systems Branch Aaron Del Monte Project Development
Supervisor
8/19/2024
Page | 6
3. INTRODUCTION
3.1 AN OVERVIEW OF THE CONTENT MANAGEMENT WEB APPLICATION
The content management application, as envisioned by the California Department of Fish and Wildlife (CDFW), is designed to facilitate the efficient management and dissemination of fishing regulations.
In response to a shift from paper-based resources to digital platforms, this application sets the foundation for the future department mobile application that will provide the public with up-to-date information on recreational fishing regulations in California. While several web applications currently offer this information online, accessibility is dependent on active internet connections. To overcome this limitation and ensure that regulations are readily accessible regardless of connectivity, CDFW will embark on the development of a mobile application.
To support this future mobile application and potential additional web clients, CDFW enhanced the existing recreational fishing regulations database and the content management application as part of RFR Phase 2a. These enhancements were necessary to meet the specific demands of the mobile application and to improve the overall user experience.
The database now accommodates spatial data (Geographic Information Systems/GIS data) to effectively associate fishing regulations with geographical features. Additionally, the content management application empowers non-technical CDFW staff to efficiently review, manage, and update regulations, considering the dynamic nature of fishing regulations. With the completion of RFR Phase 2a, both the regulation database and the content management application have been thoroughly updated and enriched to meet these objectives.
3.2 THE PURPOSE AND OBJECTIVES OF THE DOCUMENT
This Functional Design Document serves the purpose of comprehensively defining the objectives, scope, and functional requirements for enhancing the current Recreational Fishing Regulations (RFR) database and the associated content management application.
The primary goal is to align these systems with the future mobile application, which will provide real-time recreational fishing regulation information for any location in California. This document aims to articulate the specific functional improvements and enhancements required to achieve this objective.
Page | 7
4. USER ROLES AND PERMISSIONS
The RFR application encompasses several modules, which includes Species, Species Groups, Take Methods, Features, Regulations, Rules, App Viewer, and Reports. The functionality and access within these modules are governed by distinct user roles, as established within the Microsoft Entra ID framework.
The following table displays the various modules, functionalities within, and the currently defined user roles and permissions.
Module Available Function User Roles and Permissions
Staff/General User Editor Admin
Species View/Download Yes Yes Yes
Species Groups View/Download Yes Yes Yes
Take Methods View/Download Yes Yes Yes
Features View Yes Yes Yes
App Viewer View/Download Yes Yes Yes
Regulations View/Download Yes Yes Yes
Add No Yes Yes
Edit No Yes Yes
Delete (Soft Delete) No Yes Yes
View Deleted No No Yes
Activate Deleted No No Yes
Rules View/Download Yes Yes Yes
Add No Yes Yes
Edit No Yes Yes
Delete (Soft Delete) No Yes Yes
View Deleted No No Yes
Activate Deleted No No Yes
Reports View/Download Yes Yes Yes
Page | 8
5. USER INTERFACE (UI) REQUIREMENTS
For internal sites, CDFW has used the Orange County theme. Below is a screenshot of a CDFW internal site using this theme.
The RFR website will utilize the same theme above, based on the specifications defined in the following resource links:
State of California Web Template: https://template.webstandards.ca.gov/
Color themes Specifications: https://template.webstandards.ca.gov/visual-design/color.html
CDFW Web Editing Resources: https://wildlife.ca.gov/editors
Note:
This site is mainly for CDFW web editors who use the DNN CMS. However, the site contains some resources and policies that you may find useful.
https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftemplate.webstandards.ca.gov%2F&data=05%7C01%7CHemanth.Balasundaram%40Wildlife.ca.gov%7Cf56b8b39547640dda9df08dbb8567113%7C4b633c25efbf40069f1507442ba7aa0b%7C0%7C0%7C638306453640626255%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=at8MXfgbfF9snVVmOnlVMJPZNA8bjaJurs0%2FYzHd69w%3D&reserved=0 https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftemplate.webstandards.ca.gov%2Fvisual-design%2Fcolor.html&data=05%7C01%7CHemanth.Balasundaram%40Wildlife.ca.gov%7Cf56b8b39547640dda9df08dbb8567113%7C4b633c25efbf40069f1507442ba7aa0b%7C0%7C0%7C638306453640626255%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=KlPTpMSGR%2Fm4buIyyZ1CkYSl7bQi7RRCUnYRGnvph%2Bo%3D&reserved=0 https://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftemplate.webstandards.ca.gov%2Fvisual-design%2Fcolor.html&data=05%7C01%7CHemanth.Balasundaram%40Wildlife.ca.gov%7Cf56b8b39547640dda9df08dbb8567113%7C4b633c25efbf40069f1507442ba7aa0b%7C0%7C0%7C638306453640626255%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=KlPTpMSGR%2Fm4buIyyZ1CkYSl7bQi7RRCUnYRGnvph%2Bo%3D&reserved=0 https://wildlife.ca.gov/editors
Page | 9
6. CONTENT MANAGEMENT
6.1 SPECIES
6.1.1 Overview
The species page below will enable users to view, search, filter and download data from the Species table in the RFR database.
6.1.2 Navigation
Users can access the Species page by clicking the "Species" link in the global menu at the top of the page.
6.1.3 Content
Species data in the RFR database is presented in a grid format.
"Common Name" column displays species names (e.g., White Shark).
"Sorted Name" column categorizes species by type (e.g., Shark, White).
"Species Groups Names" column shows the species' group affiliations (e.g., Sharks and Finfish, as White Shark belongs to both groups).
The “View Icon” located at the right of each row will open a pop-up window displaying the full list of species group names associated to the Species. Users can close the pop-up window by selecting the (X) icon.
6.1.4 Search
The Search function filters text input through 2-3 key columns to optimize system performance.
Searching narrows down the displayed results.
Enabled search attributes include Common Name, Sorted Name and Species Groups.
The Refresh icon next to the search function will clear the user input text (if any) in the search box and refresh the grid displaying all the records back.
6.1.5 Download
Users can download all the records displayed in the grid in a CSV or PDF format by clicking the respective icons next to the Search function.
Page | 10
6.1.6 Columns
Each grid column features filter options accessible through a vertical menu.
Filter options include:
o Sort by ASC: Ascending order.
o Sort by DESC: Descending order.
o Filter: Set filter criteria.
o Hide Column: Hides the column.
o Manage Columns: Allows users to show/hide grid columns.
o Clear Filter: Resets column filter conditions.
6.1.7 Filters
Clicking "Filter" in any column's vertical menu opens a pop-up window to set filter criteria.
Page | 11
Column Name: Select the grid column to apply filtering.
Page | 12
Operator: Choose from these operators:
o Contains: Includes specified content.
o Equals: Matches exactly.
o Is empty: Has no content.
o Is not empty: Contains content.
o Starts with: Begins with provided characters.
o Ends with: Concludes with given characters.
o Is any of: Matches any from a list.
Value: Enter the desired text for the selected condition.
Page | 13
ADD MORE: To add additional column for AND filter.
6.1.8 Pagination
Pagination controls are provided to the bottom right of the data grid for navigating through the filtered results.
Page | 14
6.1.9 Actions
6.1.9.1 View Species
All users can view a species detail by clicking the “View Icon" in the Actions column.
[Popup Window] Species will be displayed when “View Icon" is clicked.
All the data fields in the popup window will be non-editable.
“X” close icon will automatically close the pop-up window displaying the Species page back to the user.
Page | 15
Page | 16
6.2 SPECIES GROUPS
6.2.1 Overview
The species Groups page below will enable users to view, search, filter and download data from the Species Groups table in the RFR database.
6.2.2 Navigation
Users can access the Species Groups page by clicking the "Species Groups" link in the global menu at the top of the page.
6.2.3 Content
Species Groups data in the RFR database is presented in a grid format.
"Name" column displays the names of the Species Groups.
"Members" column displays all the member species associated to the Species Group.
"Definition in Regulations" displays the regulation code defining the grouping.
"Tier" shows the numeric ranking associated with the species group.
"Application Group" displays a Boolean value indicating if the species group will be included in the final application.
The “View Icon” located at the right of each row will open a pop-up window displaying the full list of members associated to the Species Group. Users can close the pop-up by selecting the
(X) icon.
6.2.4 Search
Searching narrows down the displayed results.
Enabled search attributes include Name, Members, Definition in Regulations, Tier, Application
Group.
6.2.5 Download
Page | 17
6.2.6 Columns
o Sort by DESC: Descending order.
o Filter: Set filter criteria.
o Hide Column: Hides the column.
6.2.7 Filters
Page | 18
Page | 19 o Equals: Matches exactly.
o Is empty: Has no content.
o Is not empty: Contains content.
o Starts with: Begins with provided characters.
Page | 20
ADD MORE: To add additional column for AND filter.
6.2.8 Pagination
Page | 21
Page | 22
6.2.9 Actions
6.2.9.1 View Species Groups
All users can view a Species Groups detail by clicking the “View Icon" in the Actions column.
[Popup Window] Species Groups will be displayed when “View Icon" is clicked.
All the data fields in the popup window will be non-editable.
“X” close icon will automatically close the pop-up window displaying the Species Groups page back to the user.
Page | 23
6.3 TAKE METHODS
6.3.1 Overview
The Take Methods page below will enable users to view, search, filter and download data from the Take Methods table in the RFR database.
6.3.2 Navigation
Users can access the Take Methods page by clicking the "Take Methods" link in the global
6.3.3 Content
Take Methods data in the RFR database is presented in a grid format.
"Take Method Name" column displays all take method types.
"Definition in Regulation" column displays the regulation code defining the take method.
6.3.4 Search
Searching narrows down the displayed results.
Enabled search attributes include Take Method Name.
6.3.5 Download
6.3.6 Columns
Page | 24 o Sort by DESC: Descending order.
o Filter: Set filter criteria.
o Hide Column: Hides the column.
6.3.7 Filters
Page | 25 o Equals: Matches exactly.
o Is empty: Has no content.
o Is not empty: Contains content.
o Starts with: Begins with provided characters.
ADD MORE: To add additional column for AND filter
Page | 26
6.3.8 Pagination
Page | 27
6.4 FEATURES
6.4.1 Overview
The Features page below will enable users to view, search and filter Marine/Inland features of the state of California from ArcGIS database.
6.4.2 Navigation
Users can access the Features page by clicking the "Features" link in the global menu at the top of the page.
6.4.3 Content
By default, the left pane will display all the spatial features maintained by Marine and Inland
Fisheries branch in the ArcGIS Server.
Each feature displayed in the left pane includes the feature name, feature category, and the
Definition in Regulation Code defining them.
o Example: Abalone Cove SMCA, State Marine Protected Area, Parenthetical code of the regulation where the feature is defined.
Clicking the "View Icon" located to the left of each feature displayed in the left pane will trigger a series of interactions listed below.
o It highlights the corresponding feature on the map.
o Simultaneously, it generates a pop-up at the top-right corner of the map, displaying the count of Rules and Regulations associated to the selected feature. This pop-up includes a close icon for user convenience.
If a user clicks on another feature's view icon without closing the existing pop-up, the system will update the pop-up to reflect the count of rules and regulations related to the new feature.
Alternatively, if a user closes the pop-up and then selects a feature's view icon, a new pop-up will appear, displaying the count of rules and regulations related to the newly selected feature.
This responsive design ensures an intuitive user experience.
6.4.4 Search
Users can use the global search to enter a feature name and refine search results.
Users can pan the map to the desired location and zoom in (+) or out (-) as needed.
Page | 28
6.4.5 Filters
o The "Select Layer(s)" multi-selection dropdown displays the available options imported directly from ArcGIS. These currently include:
o Marine o Inland Streams o Inland Areas
The "Select Category/Categories" multi-selection dropdown is an extension of the Select Layers dropdown, and displays the available options imported from ArcGIS. The options displayed will be dynamic based on the selected Layers, ensuring precise and context-driven selection.
o For example, selecting "Marine" in the Layers dropdown will exclusively display marine specific categories in the "Category" dropdown.
The integration of selections in the "Layers" dropdown, combined with subsequent choices in the
"Category" dropdown, automatically updates the content displayed in the left pane. This seamless interaction should offer users a tailored experience, aligning with their specific data and category preferences.
Page | 29
6.4.6 Pagination
Page | 30
6.5 REGULATIONS
6.5.1 Overview
The Regulations page below will enable users to view, add new, add child, edit, delete, search, filter and download data from the Regulations table in the RFR database.
Admin View:
Editor View with “Show Deleted Regulations” disabled.
General user/ Staff user view of regulations with disabled buttons and icons.
Page | 31
6.5.2 Navigation
Users can access the Regulations page by clicking the "Regulations" link in the global menu at the top of the page.
6.5.3 Content
Regulations data in the RFR database is presented in a grid format.
"Source” column displays the source of the regulation (CCR Title 14, California Fish and Game Code, CFR Title 50).
“Code” column displays the regulation code.
“Title” column displays the regulation description.
“Parent Code” column displays the parent regulation code.
“Verbatim” column displays the actual regulation text.
“Type” column displays the CDFW branch responsible for the regulation.
o Example: Marine, Inland or General, with the latter encompassing miscellaneous regulations that may be common to Marine and Inland.
“Actions” Column displays the following enabled (instead of hiding the available functions) o For staff with General User Permissions
“View icon” to view the regulation o For staff with Editor User Permissions, in addition to above General User Permissions
“Plus” icon to add child regulation “Edit” icon to edit the regulation “Delete” icon to delete the regulation, which would be a soft delete.
“ADD NEW +” function to the top right of the grid, to add any new regulation.
o For staff with Admin User Permissions, in addition to above General User and Editor User Permissions
“SHOW DELETED REGULATIONS” function at the top right of the grid, to view and activate deleted regulations.
6.5.4 Search
Searching narrows down the displayed results.
Enabled search attributes include Code, Title and Verbatim.
The Refresh icon next to the search function will clear the user input text (if any) in the search box and refresh the grid displaying all the records back.
An additional search function is provided to narrow down the displayed results by checking and unchecking the following regulation types: Marine, Inland and General.
Page | 32
6.5.5 Download
6.5.6 Columns
o Sort by DESC: Descending order.
o Filter: Set filter criteria.
o Hide Column: Hides the column.
6.5.7 Filters
Page | 33
Column Name: Select the “Title” from the column name dropdown.
Page | 34 o Equals: Matches exactly.
o Is empty: Has no content.
o Is not empty: Contains content.
o Starts with: Begins with provided characters.
Page | 35
Users can click the “Add More” button to include additional filters for narrowing the search and click the “Remove” button to delete any extra filters.
6.5.8 Pagination
6.5.9 Actions
6.5.9.1 Add New Regulation
Only Editor or Admin users can add a new regulation by clicking “ADD NEW +” button in the regulations page. The "ADD NEW +” button will be disabled for General/ Staff users.
Page | 36
[Popup Window] Add Regulations will be displayed when “ADD NEW +” button is clicked.
[Mandatory field] Source will include a dropdown displaying the available CCR Title selection options in the RFR database, and the RFR database currently includes the following 4 options:
(i) California Fish and Game Code, (ii) CCR Title 14, (iii) CFR Title 15, and (iv) CFR Title 50
[Optional field] Parent Code: will include a searchable dropdown to select from the available parent codes in the database to create a child regulation OR leave blank to create a brand-new parent regulation.
[Mandatory field] Title: will be a free form text field.
[Mandatory field] Code: Will be pre-populated with the parent code with the cursor positioned after the pre-populated code to enter the next level when creating a child regulation OR user can enter the new code for a brand-new regulation. If the entered code is in an incorrect order or level, the system will display an error message as “Invalid Code”. If the entered code is in an incorrect format, the system is enabled to automatically format the input to the correct format.
Also, an example code format is provided below the field for users' reference. If the entered new code already exists, the system will display an error message as “This regulation already exists in the system”.
[Mandatory field] Tag: Will include a searchable dropdown to select from the available options in the database or enter a new option to add to the database.
[Mandatory field] Type: Will include a dropdown displaying the following three options: Marine, Inland and General.
[Mandatory field] Verbatim: Will be a free form text field, providing users with the flexibility to enter verbatim information.
o [Radio Button] Free Text: Users can input the verbatim information in the form of a text block.
o [Radio Button] Tabular Data: Users have the option to enter the verbatim in a tabular format, with the ability to add columns and rows.
o [Radio Button] Headers: Users can input Headers and Sub-Headers for tabular format verbatim, allowing for structured organization.
CANCEL will automatically close the Add Regulation pop-up window, displaying the regulation page back to user.
Page | 37
SUBMIT will trigger the following series of actions.
1. Update the new regulation to the RFR database displaying the following confirmation message - “Regulation updated successfully”.
2. Update the User ID and Time stamp in the RFR database for audit trail and reporting needs.
3. Close the pop-up window and display the updated regulations page back to the user.
6.5.9.2 Add Child Regulation
Only Editor or Admin users can add a child regulation by clicking the “+” button in the Actions column. This "+” button will be disabled for General users.
[Popup Window] Add Child Regulations will be displayed when the “+” button is clicked.
[Mandatory field] Source will display the CCR Title of the parent regulation and will be disabled for edit.
[Mandatory field] Code: Will be programmatically pre-populated with the parent code, with the cursor positioned after the pre-populated code to enter the next level for the child regulation. If the entered code is in an incorrect order or level, the system will display an error message as “Invalid Code”. If the entered code is in an incorrect format, the system is enabled to automatically revise the input to the correct format. Also, an example code format is provided below the field for users' reference.
[Mandatory field] Title: will be a free form text field.
[Mandatory field] Parent Code: will display the regulation code of the parent regulation and will be disabled for edit.
[Mandatory field] Tag: Will include a dropdown to select from the available options in the database.
[Mandatory field] Type: Will be pre-populated with the parent regulation type and will include a dropdown if users want to change the child regulation type different from the parent regulation type, displaying the following three options: Marine, Inland and General.
[Mandatory field] Verbatim: Will be a free form text field, providing users with the flexibility to enter verbatim information.
o [Radio Button] Free Text: Users can input the verbatim information in the form of a text block.
o [Radio Button] Tabular Data: Users have the option to enter the verbatim in a tabular format, with the ability to add columns and rows.
o [Radio Button] Headers: Users can input Headers and Sub-Headers for tabular format verbatim, allowing for structured organization.
CANCEL will automatically close the Add Regulation pop-up window, displaying the regulation page back to user.
SUBMIT will trigger the following series of actions.
1. Update the new regulation to the RFR database displaying the following confirmation message - “Regulation updated successfully”.
2. Update the User ID and Time stamp in the RFR database for audit trail and reporting
Page | 38
3. Close the pop-up window and display the updated regulations page back to the user.
6.5.9.3 View Regulation
All users can view a regulation by clicking the “View Icon" in the Actions column.
[Popup Window] View Regulations will be displayed when “View Icon" is clicked.
All the data fields in the popup window will be non-editable.
CANCEL will automatically close the pop-up window displaying the regulation page back to the user.
Page | 39
6.5.9.4 Edit Regulation
Only Editor or Admin users can edit a regulation by clicking the “Edit Icon" in the Actions column.
This "Edit Icon" will be disabled for General users.
[Popup Window] Edit Regulations will be displayed when the “Edit Icon" is clicked.
[Mandatory field] Source will display the CCR Title of the regulation and will be disabled for edit.
[Mandatory field] Code: Will display the current code and will be editable. If the entered code is in an incorrect order or level, the system will display an error message as “Invalid Code”. If the entered code is in an incorrect format, the system is enabled to automatically revise the input to the correct format. Also, an example code format is provided below the field for users' reference.
[Mandatory field] Title: Will display the current Title and will be editable.
[Mandatory field] Parent Code: will display the regulation code of the parent regulation and will be disabled for edit.
[Mandatory field] Tag: Will display the current tag, and will include a searchable dropdown to select from the available options in the database
[Mandatory field] Type: Will display the current type, and will include a dropdown displaying the following three options: Marine, Inland and General, if users want to change the regulation type, [Mandatory field] Verbatim: Will display the current verbatim, and will be a free form text field, providing users with the flexibility to enter verbatim information.
o [Radio Button] Free Text: Users can input the verbatim information in the form of a text block.
o [Radio Button] Tabular Data: Users have the option to enter the verbatim in a tabular format, with the ability to add columns and rows.
o [Radio Button] Headers: Users can input Headers and Sub-Headers for tabular format verbatim, allowing for structured organization.
CANCEL will automatically close the Edit Regulation pop-up window, displaying the regulation page back to users.
SUBMIT will trigger the following series of actions.
1. Update the edited regulation to the RFR database displaying the following confirmation message - “Regulation updated successfully”.
2. Update the User ID and Time stamp in the RFR database for audit trail and reporting
3. Close the pop-up window and display the updated regulations page back to the users.
6.5.9.5 Delete Regulation
Only Editor or Admin users can delete a regulation by clicking the “Delete Icon” in the Actions column. The "Delete Icon” will be disabled for General users.
Page | 40
[Popup Window] Delete Item will be displayed when the “Delete Icon” is clicked, showing the number of child regulations and count of rules that will also be deleted with the delete of the selected regulation. E.g., “By doing this, it will also Delete 1 child regulations and 2 rules.”
“DISAGREE” button will close the pop-up and display the regulations page back to the users.
“AGREE” button will trigger the following series of actions.
1. Do a soft delete of the selected regulation, and associated child regulations and rules with the following confirmation message - “Regulation is deleted”.
2. Update the User ID and Time stamp in the RFR database for audit trail and reporting needs.
3. Toast message appears for few seconds, on the top right corner with dialogue
“Regulation 369.1, 369.1(a) is deleted”. 369.1(parent), 369.1(a) is (child regulation).
4. When a parent regulation is deleted, all of its associated rules and child regulations, including their rules, will be deleted as well.
5. The pop-up window will close, and the updated deleted regulations page will be displayed to the user.
When a child regulation 369.1(a) is deleted, the display will show “0 child regulations and 0 rules” if there are no associated child regulations or rules. If there are associated rules, their count will be shown accordingly.
6.5.9.6 View/Activate Deleted Regulations
Only Admin users can view/activate the deleted regulations by clicking the “SHOW DELETED
REGULATIONS” button to the top right of the data grid. This button will be disabled for General and Editor users.
Admin users can view the full details of deleted regulations by clicking the “VIEW” icon in the Actions column.
The admin users can activate the deleted regulations by clicking the “ACTIVATE” button in the Actions column.
[Popup Window] Activate Regulation When you click the “ACTIVATE” button, the "Activate Regulation" message will appear, showing the number of rules that will also be activated along with the selected parent regulation (e.g., “This will also activate 1 rule.”). Please note that none
Page | 41 of the child regulations or their rules will be activated; they must be activated separately, one child regulation at a time.
“DISAGREE” button will close the pop-up and display the deleted regulations page back to the user.
“AGREE” button will trigger the following series of actions.
1. Undo the soft delete of the selected regulation, and associated child regulations and rules with the following confirmation Toast message - “Regulation 369.1 is activated Successfully”.
2. Update the User ID and Time stamp in the RFR database for audit trail and reporting needs.
3. The pop-up window will close, and the updated deleted regulations page will be displayed to the user.
“BACK TO REGULATIONS” button at the top right of the grid displayed in the deleted regulations page will display the main regulations page back to the users.
Page | 42
6.6 RULES
6.6.1 Overview
The Rules page below will enable Admin users to Refresh Features, See Deleted Rules, add new rule, clone, view, edit, delete, search, filter and download data from the Rules table of the database.
As an Admin, clicking the "Refresh Features" button will sync the updated feature data from ArcGIS to the RFR database.
In the Editor User view, the "Refresh Filter" and "Show Deleted Rules" buttons will be disabled.
Page | 43
However, the button "Add New+," actions icons "Clone," "View," "Edit," and "Delete" will remain enabled.
In the Staff/General User view, the "Refresh Filter," "Show Deleted Rules," "Add New+," "Edit," and "Delete" buttons and icons will be disabled. However, the "Clone" and "View" icons will remain enabled.
Hide Column: click on the filter's icon for the desired column to hide, now click on the “Hide Column”.
Page | 44
Manage Column (to un-hide): click on the filter's icon on any column to un-hide a hidden column, click on the “Manage Columns”, click on the unchecked column name to check and make the column appear back in the grid by clicking the “Save” button.
6.6.2 Navigation
Users can access the Rules page by clicking the "Rules" link in the global menu at the top of the page.
Page | 45
6.6.3 Content
Rules data in the RFR database is presented in a grid format.
"Feature” column displays the feature ID and feature name the rule is applicable for.
“Regulation” column displays the regulation code the rule is derived from.
“Rule Type” column displays the rule type.
“Species Group” column displays the species group the rule applies for.
“Species” column displays the species the rule applies for.
“Restriction” column displays the fishing restriction type.
“Edit Date” column displays the date the rule was last added or edited.
“Actions” Column displays the following enabled (instead of hiding the available functions) o For staff with General User Permissions
“View icon” to view the rules o For staff with Editor User Permissions, in addition to above General User Permissions
“Edit icon” to edit the rule “Delete icon” to delete the rule, which would be a soft delete “ADD NEW +” function at the top right of the grid, to add new rule o For staff with Admin User Permissions, in addition to above General and Editor User Permissions
“SHOW DELETED RULES” function at the top right of the grid, to view and activate deleted rules.
6.6.4 Search
Searching narrows down the displayed results.
Enabled search attributes include Feature, Regulation, Rule Type, Species Group and Species.
The “CLEAR” icon next to the Search function will clear the search text (if any) in the Search box displaying back all the records in the RFR database.
6.6.5 Download
6.6.6 Columns
Page | 46 o Sort by DESC: Descending order.
o Filter: Set filter criteria.
o Hide Column: Hides the column.
6.6.7 Filters
Page | 47 o Equals: Matches exactly.
o Is empty: Has no content.
o Is not empty: Contains content.
o Starts with: Begins with provided characters.
6.6.8 Pagination
6.6.9 Actions
6.6.9.1 Clone/ View/ Edit/ Delete (Rule icons)
Clone: The clone icon located on the right-side of each row allows users to duplicate an existing rule, make required adjustments, and swiftly create a new rule under the same regulation.
View: The view icon on the right side of each row lets users access the full details of a rule in a popup or page. This view can be closed by clicking the close button.
Edit: The edit icon on the right side of each row allows only Admin and Editor users to modify the existing rule. Clicking the icon will open the rule's full details in a popup or page for editing. This view can be closed by clicking the close button. The edit icon will be disabled for general or staff users.
Page | 48
Delete: The delete icon on the right side of each row permits only Admin and Editor users to remove an existing rule. Clicking this icon will open a "Delete Item" confirmation popup with "Agree" and "Disagree" buttons. Selecting "Agree" will delete the rule, while "Disagree" will close the popup without making any changes. The delete icon will be disabled for general or staff users.
Field Descriptions:
Field Field Type Default Value Required
Enabled for Edit/Select
Values
Add Edit View
Popup Page Title Text Not Applicable Y N N N If navigating from Rules Page:
Add Rule, Edit Rule, View Rule
If navigating from App Viewer:
View Rule - (Application Group)
Regulation Parenthetical Searchable Dropdown Select Regulation Y Y N N Will display the list of codes in the RFR database by searched text.
Regulation Title Auto-populated Null Y N N N Will display the title of the Regulation Code selected
Regulation Verbatim Auto-populated Null Y N N N Will display the verbatim of the regulation code selected
Show All Verbatim Button Not Applicable N Y Y Y Will display all verbatim of the regulation code selected, including the parent, grand-parent and all the way to the root, in a pop-up window with close-button. User shall be able to (I) drag the pop-up window to the desired location on the screen, (ii) increase or decrease the width and height of the pop-up window, and (iii) scroll up or down the pop-up window to view full verbatim.
Clicking the close button will close the pop-up.
Feature Name Searchable Dropdown Select Feature Y Y Y N Will display Feature Names in ArcGIS by searched text
Select from Map Link Not Applicable N Y Y N Will display a pop-up map window showing marine, inland, general features relating to the regulation code in ArcGIS.
Rule Type Dropdown Rule Type Y Y Y N Will display the list in the RFR database
Species Groups Searchable Dropdown Species Group N Y Y N Will display the list in the RFR database by searched text
Species Searchable Dropdown Species N Y Y N Will display the list in the RFR database by searched text
Restriction Type Dropdown Restriction Type Y Y Y N Limit, Prohibited, No Limit
Limit Type Mult-select Checkbox Limit Type N Y Y N Daily, Annual, Possession
Measurement Type (Enable if Restriction Type selected is equal to Limit)
Dropdown Measurement Type
N
Y Y N Count of individuals, Volume, Weight, Total Length, Alternate Length, Fillet Length, Fork Length.
Comparative Type (Enable if Restriction Type selected is equal to Limit)
Dropdown Comparative Type N
Y Y N Less than, Greater than, less than or Equal to, Greater than or Equal to
Measurement Unit (Enable if Restriction Type selected is equal to Limit)
Dropdown Measurement Unit N
Y Y N If Count of individuals = Individual Units If Volume = Bucket, Gallons, Liters If Weight = Pounds
Limit (Enable if Restriction Type selected is equal to Limit)
Numeric 0 N Y Y N User Entered
Page | 49
Take Methods Searchable Dropdown Take Methods N Y Y N Will display the list in the RFR database by searched text
Fishing Methods Dropdown Fishing Methods N Y Y N Will display the list in the RFR database
Details Text Null N Y Y N Freeform User Text Entry
Staff Comment Text Null N Y Y N Freeform User Text Entry
All Year Toggle ON N Y Y N ON, OFF
Start MM/DD Calendar Dropdown Yes Y Y Y N Select from Calendar
Start MM/DD Calendar Dropdown Yes Y Y Y N Select from Calendar
CLOSE Button Not Applicable N Y Y Y Will close the pop-up window and navigate the user back to the rules list page.
NEXT Button Not Applicable N Y Y N Will navigate the user to the next page of the rule's details pop-up window.
Create New Rule for: All Year
Page | 50
Create New Rule for: from specific” Start Date” to” End Date”
“Select from Map” link will open a new pop-up map window shown below, where user can o Search the feature in the left pane by entering text in the Searchable dropdown.
o Search the feature in the right pane by clicking a point on the map.
o Search the feature by selecting the layers and categories from the dropdowns at the top left corner of the map in the right pane.
o All the above actions will display a narrowed down list of features in the left pane, from which user can select the feature they need.
o Clicking the “View Icon” to the left of the displayed list of features in the left pane will display the number of regulations and rules associated with the feature.
o Clicking the “SELECT” button to the left of the displayed list of features in the left pane will close the pop-up map window and take the user back to the Add/Edit Rule pop-up window with the selected feature populated in the Feature field.
o Clicking the close icon” X” at the top right corner of the map in the right pane will close the pop-up map window and take the users back to the Add/Edit Rule pop-up window without altering the selection or non-selection in the Feature field.
Page | 51
CLOSE icon at the top right of the screen will close the Add/Edit/View pop-up window and return the users back to the Rules page.
NEXT link at the bottom right of the screen will take the users to the “Rule Summary” page of the Add/Edit pop-up window, shown below. This link will be disabled for “View Rule” pop-up window.
SAVE link at the bottom right of the screen in the above “Rule Summary” page will update the rule to the Rules table in the RFR database, along with the user id and updated timestamp in the following format for audit trail purpose: User ID | 07/06/2023 01:53 PM PST.
6.6.9.2 Delete Rules
Only Editor or Admin users can delete a rule by clicking the “Delete” icon in the Actions column.
The "Delete” icon will be disabled for General users.
Page | 52
[Popup Window] Delete Item will be displayed when the “Delete” icon is clicked, showing the following message - “Are you sure you want to delete this item?”.
“DISAGREE” button will close the pop-up and display the rules list page back to the users.
“AGREE” button will trigger the following series of actions.
1. Do a soft delete of the selected rule with the following confirmation Toast message on the top right corner of the screen - “Rule is deleted successfully!”.
2. Update the User ID and Time stamp on the deleted rule record in the RFR database for audit trail and reporting needs.
3. Pop-up window will disappear and display the updated rules list page back to the user.
6.6.9.3 View/Activate Deleted Rules
Only Admin users can view or activate deleted rules by clicking the “SHOW DELETED RULES” button at the top right of the data grid. This button will be disabled for General and Editor users.
The admin users can activate the deleted rules by clicking the “ACTIVATE” button in the
Actions column of the data grid.
If the regulation related to the rule being activated is still active, the following toast message will be displayed at the top of the screen - “Rule successfully activated”.
If the regulation associated with the rule being activated has also been deleted, a red toast message will appear at the top of the screen: “The regulation with # Regulation Code for this rule has been deleted. Activating this regulation will also activate this rule.” Please click the
Page | 53 regulation code link to activate the regulation.
Clicking the Regulation Code link will take you to the “Deleted Regulations” page, where you can activate the related regulation.
Page | 54
6.7 APP VIEWER
The below App Viewer module is developed based on the following technical details document provided by Marine Region in consultation with the Inland Fisheries branch and BDB team: RFR App Viewer.pptx
6.7.1 Overview
The App Viewer page below will allow users to view, filter and download rules and regulations relating to marine and inland fishing locations, by clicking on the map and for a specific selected date.
https://cdfw.sharepoint.com/:p:/r/teams/Project-RFMApp-P1/Shared%20Documents/Phase%202a/Requirements/RFR%20App%20Viewer.pptx?d=w69163e600a824b21acf2876da4ca7f3f&csf=1&web=1&e=xet0hX
Page | 55
6.7.2 Navigation
Users can access the App Viewer page by clicking the "App Viewer" link in the global menu at the top of the page.
The initial App Viewer page should display the map of California, and a searchable dropdown at the top left of the map (as in a google map) with the following prompt — "Select location to view fishing regulations and rules”.
Alternatively, the user should be able to navigate the map by panning to desired location and zoom in (+) and zoom out (-) to select a location.
Upon selection of a location, the following sections and fields should become viewable in the page o “Search” function to filter the items displayed in the grid by the searched text.
o “Clear Search” icon to clear the Search.
o “Marine” and “Inland” radio buttons to filter the items displayed in the grid by feature type.
By default, both, either or none will be checked as applicable to the selected location.
o “Active Date” will display rules/regulations that are active on the selected date and will be defaulted to current date.
o “Features View” will show enabled if Marine radio button is selected or checked, and it will show disabled if Marine radio button is not checked.
o Export to PDF and export to CSV icons to download the items displayed in the grid.
o Details grid will display the following columns: Feature, Application Group, Regulation
Code, Rule Type, Fishing Method, Restriction, Take Method, Rule_Species, Limit Type, Start Date, End Date, Actions …. (TBD).
o Pagination function to navigate between pages
Page | 56
6.7.3 Content
6.7.3.1 Rules View
Rules data from the Rules table in the RFR database is presented in a grid format.
o Rules are filtered using logic from tier levels/weighting applied to features, species groups and rule types as specified above in section 6.7.
"Feature” column displays the marine and inland features for the selected location.
“Application Group” column displays the final application group of the Rule_Species.
“Regulation Code” column displays the regulation code the rule is related to.
“Rule Type” column displays the rule type.
“Fishing Method” column displays the fishing method if applicable for the rule.
“Restriction” column displays the fishing restriction type if applicable for the rule.
“Take Method” column displays the take method if applicable for the rule.
“Rule_Species” column displays the species name related to the rule.
“Limit Type” column displays the limit type if applicable for the rule.
“Start Date” column displays the start mm/dd the rule is active for the season.
“End Date” column displays the end mm/dd the rule is active for the season.
Page | 57
“Actions” Column will display only a “View” icon. Clicking this icon will display “View Rule” pop-up window to view the rule details, with an additional “Application Group” field associated to the rule from App Viewer page added to the header.
6.7.3.2 Features View
Features data from the Features table in the RFR database is presented in a grid format.
"Feature” column displays the feature ID and feature name.
“Category” column displays the category type of the feature.
“Definition in Regulation” column displays the regulation defining the feature.
6.7.4 Search
Searching narrows down the displayed results.
Enabled search attributes includes Application Group, Rule Type and Rule_Species.
The Refresh icon next to the search function will clear the user input text (if any) in the search
Page | 58
6.7.5 Download
6.7.6 Pagination
Pagination controls are provided at the bottom right of the data grid for navigating through the
Page | 59
6.8 REPORTS
6.8.1 Regulations Report
6.8.1.1 Overview
The Regulations Report page will allow users to select all or a subset of regulations to preview and download to a PDF or CSV file
6.8.1.2 Navigation
User can access the Regulations Reports page by clicking “Regulations" under “Reports” in the global menu at the top of the page.
6.8.1.3 Content
[Radio Button] “Select All Regulations” will automatically check all options in the sub-selection options below.
Alternatively, users can customize the selection for the regulations report by checking and unchecking any combination of the below check boxes.
o [Check Box] Marine Regulations, to select regulations related to Marine features.
o [Check Box] Inland Regulations, to select regulations related to Inland features.
o [Check Box] General Regulations are all those regulations are those that relate to both
Marine and Inland.
o [Check Box] CCR Title 14, to select regulations relating to CCR Title 14, where CCR stands for California Code of Regulations.
o [Check Box] CA Fish and Game Code, to select regulations relating to CA Fish and
Game Code regulations, where CA stands for California.
o [Check Box] CFR Title, to select regulations relating to CFR Title, where CFR stands for
Code of Federal Regulations.
Additionally, user can select a further subset of regulations by selecting the options available in the Tags searchable dropdown.
[Radio Buttons] PDF can be selected to download the report as a pdf file, which will be in a list format shown below.
Page | 60
[Radio Buttons] CSV can be selected to download the report as a csv file of rows and columns.
[Action Button] Preview will open a pop-up window with a close button to preview the selected report before downloading.
[Action Button] Download will download the selected report.
Page | 61
6.8.2 Rules Report
6.8.2.1 Overview
The Rules Report page will allow users to select all or a subset of the rules relating to a species or species group to preview and download to a PDF or CSV file.
6.8.2.2 Navigation
Users can access the Rules Report page by clicking “Rules" under “Reports” in the global
6.8.2.3 Content
[Radio Button] “Select All Rules” will select all species and species groups related rules in the
RFR database.
[Searchable Dropdown] Select Species or Species Group will allow user to select rules specific to a species or species group for the rules report.
[Radio Buttons] PDF can be selected to download the report as a pdf file.
Page | 62
[Radio Buttons] CSV can be selected to download the report as a csv file of rows and columns.
[Action Button] Preview will open a pop-up window with a close button to preview the selected report before downloading.
[Action Button] Download will download the selected report.
Page | 63
7. SEARCH AND NAVIGATION
Within the RFR application, the following features have been incorporated to facilitate seamless user search and navigation experiences:
o Global Menu:
Positioned at the top of the page, the Global Menu provides users with direct links to diverse content management modules. This navigation element serves as a centralized access point, enhancing user efficiency in accessing relevant functionalities.
o Navigation Instructions and Tool Tips:
To further streamline user interaction, Navigation Instructions and Tool Tips have been strategically integrated, where deemed necessary. Section 6 of this document expounds upon the specifics of these guidance features, offering comprehensive details tailored to each relevant module. These instructions are designed to augment user understanding and proficiency within the application.
Page | 64
8. USER REGISTRATION AND AUTHENTICATION
Users must be established within the Azure Microsoft Entra ID framework, and authentication for access is achieved through Microsoft Entra ID credentials.
Also, the Microsoft Entra ID framework incorporates Application roles. Successful access to specific modules within the RFR management application is contingent upon users being…
This is the start of the file's text. The full file is on GovTribe.
File details come from the government source that posted it. Updated .