You are on page 1of 31

Food Ingredient Center

Scope Document

Proposal: Food Ingredient Center Scope Document


Date: March 29, 2018
Outline:
1. Introduction
a. Subscription Manager
2. Food Ingredient Center
a. Food Ingredient Library
i. Market Selection Page
ii. Market Pages
iii. Regulations Database
iv. Search
b. Reports and Charts
i. Market Information Reports
ii. Market Regulatory Outline
c. News Feed
i. Food Ingredient News Blog
ii. Newest Additions News Feed
iii. Pending Regulations News Feed
iv. Filters
d. My Regulations
i. Notes
e. Menu
3. Data Entry System
a. Regulations
b. Markets
c. Filterable Values
4. Future Options
a. Remind Me Function
b. My Custom Reports Page
1. Introduction

The Food Ingredient Center is a product that allows users to easily achieve four main goals:
• access and search a library of international food ingredient regulations
• stay-up-to date on worldwide food ingredient regulatory news
• personalize the system to view only those regulations relevant to the user
• share regulatory information across users within organizations

To do this, the Food Ingredient Center is split into three main parts. First is the Food Ingredient Library, where clients can select a specific market
to see summaries of the regulatory structure of the market written by regulatory analysts, see summaries for each regulation subject (food
additives, flavorings, enzymes, processing aids, nutritional additives, food specification standards, and ingredient specification standards), and
view a simple online library database of in-effect, pending, proposed, and archived regulations and amendments for the market. To aid client
understanding, the system will also include Market Information Reports (MIRs), which are documents written by the regulatory analysts that help
users understand the full regulatory picture of a market.

The second part of the system is a News Feed that allows clients to see recently uploaded regulations, as well as upcoming effective dates and
comment deadlines. This news feed will also have a blog where the regulatory analysts can post in-depth stories regarding new regulations. This
blogging service will push a weekly newsletter via email containing all stories published for the week. The News Feed will be customizable by a
system of tags/filters so that users can create a personalized feed with only the subjects and markets they care most about.

Lastly, to further personalize the system, users will be able to save specific items from the Food Ingredient Library to a personalized sub-library to
easily access the most recent version of these documents in one pane, rather than having to search by selecting a market.

a. Subscription Manager
The Food Ingredient Center will require a subscription manager. From the landing page, users will be taken to a log-in screen where they will be
required to enter their log-in credentials. After successfully entering their credentials, users will be taken to the Food Ingredient Center. This
subscription manager should be connected to the BCGlobal subscription management and password authentication system.
2. Food Ingredient Reporting System

a. Food Ingredient Library:


The Food Ingredient Library is the main product offering of the Food Ingredient Center. It is a collection of food ingredient regulations that include
value-added analysis by regulatory analysts. This will require a few main page types which are explained below.

i. Market Selection Page:


The Market Selection Page will allow users to select one market to view. This should be a simple page including all countries included in the
database with radio buttons. Only one market should be selectable at a time and selecting a market will then bring the user through to the selected
market’s page.
ii. Market Pages:
Each Market Page will have three parts: a regulatory summary section, subject summaries (dependent on the subject chosen), and the regulations
in the library (dependent on the status chosen). Each of these is outlined below.
At the top of the page is the Regulatory Summary. This should be a simple text box where regulatory analysts can include a short summary of the
selected market. Ideally no longer than a paragraph, this can be written in a simple text editor and does not need to autofill automatically from a
table. Below the paragraph there should be a link to the selected market’s Market Information Report (see section b(i)) and the Regulatory Outline
for the selected market (see section b(ii)). These will open into a new tab in the web browser. Immediately to the right of the Regulatory Summary
there will be a small textbox for the Market Overview List. This will serve as a way for users to see what each market is using to regulate each
regulation subject. It is a list of all the different regulation subjects in the database with text next to each subject with a short description. These
descriptions should be pre-set, so analysts choose from a drop-down menu. The descriptions will have different formatting (colors) depending on
which is chosen.

Below the Regulatory Summary there should be a bar with all the regulation subjects listed for the user to choose from. These can be thought of
as different tabs that, when selected, inform which Subject Summary and Regulations appear below. As our library may expand in the future, it
would be necessary to be able to add more tabs in the future if we expand into different regulatory subjects. When a regulation subject is selected,
the Subject Summaries and Regulations that have the corresponding subject should open below.

The Subject Summary will be identical in format to the Regulatory Summary. They will be text boxes with one paragraph of text that can be
maintained by regulatory analysts in text editors without any auto filling from tables. Below the paragraph there should be a link to the selected
market’s Market Information Report (see section b(i)). This will link to the specific subheader of the Market Information Report that corresponds to
the regulation subject.
The Regulations section of the page will pull relevant information from the Regulations Database (see section a(iii)). These regulations should be
divided in a tabular system by the regulation status field, similar to how the regulation subjects are designed earlier on the page. When a user
selects a regulation status, all regulations for the selected market and selected regulation status should populate below in a list format. Each entry
in the list should include the regulation title and the description from the description field. The save icon for the My Regulations page and the note
icon should also appear for each entry (see section d). Notes should be viewable from here. Any regulations (excluding amendments and WTO
notifications) that are linked in a parent/child relationship should be displayed with symbols that denote they are linked (such as an asterisk). An
example of this can be seen in Figure II. Note that the “List of Designated Additives” and “Standard of Use for Food Additives” both have asterisks
after their names to denote that they need to be considered together. It is unlikely that there will be more than one or two pairs of complementary
regulations per market, but in the event there are many complementary regulations, different symbols should be used to denote the groups. Next
to each regulation title, there should be an expand button that will open a collapsible pane that includes the regulation details below:
• Effective Date (for in-effect and pending regulations); National Comment Deadline and International Comment Deadline (for proposed
regulations); and Revocation Date (for archived regulations)
• Agency
• A link to the Official Regulation uploaded file
• A link to the Translation uploaded file (if applicable)
• A link to the WTO Notification linked as its child (if applicable)
• Notes
All amendments that are linked to a parent regulation should appear in a collapsible list below the regulation. The following fields should be
included:
• Amendment Title
• Effective Date (for in-effect and pending amendments); National Comment Deadline and International Comment Deadline (for proposed
amendments); and Revocation Date (for archived amendments)
• A link to the Official Amendment uploaded file
• A link to the Translation uploaded file (if applicable)
• A link to the WTO Notification linked as its child (if applicable)
• Notes

In some instances, the amendment may have a different regulation status than the parent regulation. Below is the logic that should be applied in
each case:
• If parent regulation status equals in-effect and amendment status equals pending or proposed, then it should appear in the collapsible list
of amendments with the parent regulation in the “in-effect” tab. It should also appear in the “pending” or “proposed” tab as its own
regulation and include an additional detail, the parent regulation title.
• If parent regulation status equals in-effect and amendment status equals archived, then the amendment should not appear in the
collapsible list of amendments with the parent regulation in the “in-effect” tab. It should ONLY appear in the “archived” tab and include an
additional detail, the parent regulation title.

At any point that the regulation and amendment status are changed to be the same (i.e. a pending amendment becomes an in-effect amendment
or an in-effect regulation becomes an archived regulation) the relationship should go back to the original format.
iii. Regulations Database:
The Regulations Database will be the framework for storing the regulatory library. The regulatory analysts will enter information about the
regulation in the data entry system. They will also need to upload the regulation file itself (and any translations necessary). The regulations will
need to be able to be linked to each other, as some of them will be amendments or complementary regulations to a main regulation. This will be
noted as a parent/child relationship, where any children should appear with the parent regulation in the Regulations section of the Market Page
(See section a(ii)).

Below is a table of fields and short descriptions that the regulatory analysts will need to enter when they upload a new regulation. An asterisk
denotes a required field. All other fields should be optional.

Field Description

Regulation Title* Short text

Regulation Title (Original Language) Short text - non-English language

Market* Short text - selected from a predetermined drop-down list

Publication Date* Date (MM/DD/YYYY) or (MM/YYYY)


Field Description

Effective Date Date (MM/DD/YYYY) or (MM/YYYY)

Revocation Date Date (MM/DD/YYYY) or (MM/YYYY)

National Comment Deadline Date (MM/DD/YYYY)

International Comment Deadline Date (MM/DD/YYYY)

Regulation Subject* Short text - selected from a predetermined drop-down list. Need to be able to select multiple values for
one entry
Description* Long text

Notes* Long text

Language* Short text - selected from a predetermined drop-down list. Ability to select multiple values

Regulation Status* Short text - selected from a predetermined drop-down list

Official Regulation* Uploaded file

Agency* Short text

Translation Uploaded file

Parent Regulation Short text – enter manually and have a subform that lists all of a market’s regulations

Logged Date* Date (MM/DD/YYYY HH:MM) (autofill with date/time, but editable by analysts)

Research Notes Long text


Field Description

URL* URL

There will be a subset type of documents that will need to be included in the database that will not fit into the general format of the other
regulations. These are WTO Notifications and Amendments. Both of these documents are unique as they will always have a parent regulation.
Amendments and WTO notifications will always appear with their parent regulations in the user interface.

Amendments:
Amendments will always appear with their parent regulations when they are queried in the user interface. The only exception is when a regulation
has a regulation status of “In Effect” and the amendment has a different regulation status. In this instance, if the status is “pending” or “proposed” it
should appear with a note or symbol designating the pending or proposed status along with the in-effect regulation. The amendment should also
appear in the Pending and Proposed tabs, with a note about which in-effect parent regulation they are attached to. If the status is “archived” the
amendment should not appear along with the in-effect regulation on the in-effect tab. It should appear only in the archived tab with a note about
which in-effect parent regulation it’s attached to. If the parent’s regulation status is also “archived” then they can both appear in the archived tab.
Below are the fields needed by amendments:

Field Description

Amendment Title* Short text

Amendment Title (Original Language) Short text - non-English language

Publication Date* Date (MM/DD/YYYY) or (MM/YYYY)

Effective Date Date (MM/DD/YYYY) or (MM/YYYY)

Revocation Date Date (MM/DD/YYYY) or (MM/YYYY)

Notes* Long text

Language* Short text - selected from a predetermined drop-down list.


Field Description

Amendment Status* Short text - selected from a predetermined drop-down list

Official Amendment* Uploaded file

Translation Uploaded file

Parent Regulation* Short text - enter manually and have a subform that lists all of a market’s regulations

Logged Date* Date (MM/DD/YYYY HH:MM) (autofill with date/time, but editable by analysts)

Research Notes Long text

URL* URL

WTO Notifications:
WTO Notifications will always appear with their parent regulations. The only difference is that parent regulations for WTO notifications can be
normal regulations or amendments. They should always appear alongside the parent regulation and do not have separate statuses. They should
always appear as a linked document wherever the parent regulation appears. Below are the fields needed for WTO Notifications:

Field Description

WTO Title* Short text

Publication Date* Date (MM/DD/YYYY)

Notes* Long text

Parent Regulation* Short text - enter manually and have a subform that lists all of a market’s regulations
Logged Date* Date (MM/DD/YYYY HH:MM)

Research Notes Long text

WTO Notification File* Uploaded file

URL* URL

iv. Search:
The menu should also include an option title “Search.” This will act as a simple way to search the documents for key terms. There will be a general
search and advanced search options. The search bar should search all documents saved to the regulatory library, notes made in the system, and
the market information reports.

The basic search should work much like a simple search bar. The user will type a phrase into the search bar. All documents, notes, and market
information reports that contain this phrase should then appear below. Information that should appear is the Regulation Title, Market, Regulation
Status, Regulation Type, and Regulation Subject. A snippet of the text that was found with the queried phrase should be included, highlighting the
queried term. For Market Information Reports or notes with the system, the title of the page should appear. When a search result is chosen, it
should take the user to the highlighted snippets of text that include the search term (much like if the user had used CTRL+F on the document).
This search functionality is likely to return a large number of irrelevant results. As such, an advanced search function is necessary. The user
should be able to filter the results based on the following fields from the regulations database: Market, Regulation Subject, Regulation Type, and
Regulation Status. The user should be able to make multiple selections for each filter (i.e. be able to choose Japan AND China for the market).
There should also be an option to toggle on/off searching the Market Information Reports and system notes. The results should appear the same
way as the basic search, just now filtered down based on the search parameters. The filters should only when searching documents in the
regulatory library, with the exception of the filter market. This filter should also be applied when searching Market Information Reports and notes
made in the system. The filter on this level should work by only searching the Market Information Report and notes tied to the filtered market(s).
b. Reports and Charts:
Additional reporting needs are outlined below. They include the Market Information Reports and the Market Regulatory Outline and are meant to
serve as additional resources for users. The analysts will generate the Market Information Reports themselves, while the system should generate
the Market Regulatory Outline.
i. Market Information Reports:
Market information Reports will be documents that the regulatory analysts will create that include a general review of a country’s regulatory
framework. Each report will include information on every regulation subject in the database. The market information reports will appear as text
within the interface and should be written/managed by the analysts. These reports should have bookmarked headers and subheaders that can be
linked to throughout the system. The user should be able to access the Market Information Reports in a few key ways. First, they should be able to
select “Market Information Reports” option from the menu. This should bring up a market selection page, in which they can choose which market’s
report they wish to view (similar to the market selection page mentioned in the regulation library section). Second, as mentioned previously, there
should be links to each market’s corresponding market information report in each market page underneath the regulatory summary (see section
a(ii)). This link should take the user to the top of the market’s report. There should be a second link under the subject summary for each regulatory
subject, which will take the user to the specific heading or subheading of the report that corresponds to the chosen regulation subject.
ii. Market Regulatory Outline:
Each market will have a Market Regulatory Outline. This chart will show the entire list of regulations for each market, and which subjects they
regulate. These will allow the users to quickly determine which regulations are relevant for each of the regulation types.

For each market, the system will auto-generate a Market Regulatory Outline. The charts will be selectable from the market regulatory outline link
located under the Regulatory Summary of each Market Page (see section a(ii)). The charts will then open into a new tab. These maps will take a
spreadsheet form and will follow a set template. The regulatory subjects should be listed on the horizontal axis with all regulation titles for the
market on the vertical access. The user should be able to open each regulation by clicking on the regulation title. Each intersecting cell where a
regulation title and a regulation subject meet will have a check mark if the regulation title is tagged with that subject. Any cells where the regulation
title is not tagged with the subject in the column should be blank. The system will determine which columns should have check marks based on
the regulation subject values tied to the regulation.
c. News Feed:
The Food Ingredient Center will include a News Feed, which will be comprised of five elements: the Food Ingredient News blog, the Newest
Additions to Regulatory Library feed, the Pending Regulations feed, filters, and the Menu sidebar. The Food Ingredient News blog will be a blog
written by the regulatory analysts. The two feeds will be auto-generated depending on values drawn from the regulations contained in the
Regulations Database. The filters will allow the blog and news feeds to be filtered based on the same set of values.
i. Food Ingredient News Blog:
The Food Ingredient News will be a blog of stories written by the regulatory analysts. Each blog story should follow a set template: publication
date, title, body of blog, regulations sub-body (optional), and tags. The regulatory analysts should have the option to include or not include the
regulations sub-body. By default, the newest story will be maximized, while each succeeding story will be minimized to the title and a story
preview. The regulatory analysts should be able to set where the story preview ends. There should also be a scroll bar that will allow users to
scroll down the Food Ingredient News element to see all past news stories.

Stories should be added to the blog feed in chronological order. However, the regulatory analysts should be able to pin stories so that they can
remain at the top of the blog feed until they are unpinned. If a story has been pinned, it should be maximized, while all other stories are then
minimized.

For the Food Ingredient News blog, a unique tagging system will be needed. The regulatory analysts should be able to select tags from only four
categories of tags: market, regulation subject, regulation type, and regulation status. The values contained in each category should be drawn from
the values for the corresponding data field contained in the Food Ingredient Database (or in the case of the regulation type, from the type of the
regulation: regulation, amendment, WTO notification). The number of tags that the regulatory analysts can select should be limited only by the
number of possible values within each category. The tags should be listed in the Food Ingredient News blog first based on category: market,
regulation subject, regulation type, regulation status. Each regulation should then be listed alphabetically within each category

ii. Newest Additions to Regulatory Library News Feed:


The Newest Additions to Regulatory Library feed will show a list of the regulations most recently added to the Regulation Library. These
regulations will be listed chronologically. All regulations types should be included: regulations, amendments, and WTO notifications. By default,
regulation details will be minimized. Please note that regulation subject(s) should always be maximized. As such, the maximize/minimize button
will not affect the regulation subject(s) field. There should also be a scroll bar that will allow users to scroll down the Newest Additions to
Regulatory Library element to see all past news stories.

The Newest Additions to Regulatory Library feed should include the following fields of data, which are to be drawn from the Regulations Database:
• Regulation Title
• Regulation Subject(s)
• Effective Date (for in-effect and pending regulations); National Comment Deadline and International Comment Deadline (for proposed
regulations)
• Agency
• A link to the Official Regulation uploaded file
• A link to the Translation uploaded file (if applicable)
• A link to the WTO Notification linked as its child (if applicable)
• Notes
Each regulation in the Newest Additions News Feed will include a save icon which will allow the user to save the regulation to the My Regulations
page. This icon will be grayed out if a regulation has already been saved to My Regulations. If the regulation has yet to be saved, the save icon
will not be grayed out.

Next to the save icon will be a pencil icon that will allow the users to access the Notes function (See Section d(i)).

The title for each story will be auto-populated from the fields of the regulation found in the Regulation Library. First, the field market should be
auto-populated. This should be followed by a dash. Next, the field regulation title should be auto-populated. As such, the regulation title should be:
Market + - + Regulation Title. For amendments and WTO notifications, this type should be auto-populated within parentheses [(Amendment) or
(WTO Notification)] following the regulation title. However, if the string “amendment” appears in the regulation title, “Amendment” should not be
appended to the story title. As such, the format should be: Market + - + Regulation Title + [(Amendment) or (WTO Notification)].

iii. Pending Regulations Feed:


The Pending Regulations feed will show a list of pending regulations, ordered chronologically with the regulation closest to its effective date listed
first. Only pending regulations and amendments will be listed. This will be done by auto-populating the list with regulations entered into the
Regulation Library which have a future date for the field effective date. By default, regulation details will be minimized. Please note that regulation
subject(s) should always be maximized. As such, the maximize/minimize button will not affect the regulation subject(s) field. There should also be
a scroll bar that will allow users to scroll down the Pending Regulations element to see all past news stories.

The Pending Regulations feed should include the following fields of data, which are to be drawn from the Regulations Database:
• Regulation Title
• Regulation Subject(s)
• Effective Date
• Agency
• A link to the Official Regulation uploaded file
• A link to the Translation uploaded file (if applicable)
• A link to the WTO Notification linked as its child (if applicable)
• Notes

Each regulation in the Pending Regulations News Feed will include a save icon which will allow the user to save the regulation to the My
Regulations page. This icon will be grayed out if a regulation has already been saved to My Regulations. If the regulation has yet to be saved, the
save icon will not be grayed out.

Next to the save icon will be a pencil icon that will allow the users to access the Notes function (See Section (i)).

The title for each story will be auto-populated from the fields of the regulation found in the Regulation Library. First, the field market should be
auto-populated. This should be followed by a dash. Next, the field regulation title should be auto-populated. As such, the regulation title should be:
Market + - + Regulation Title. For amendments, the type should be auto-populated within parentheses (Amendment) following regulation title.
However, if the string “amendment” appears in the regulation title, “Amendment” should not be appended to the story title. Then another dash
should be auto-populated. Finally, the field effective date should be auto-populated. As such, the format should be: Market + - + Regulation Title +
[(Amendment)] + Effective Date.

iv. Filters:
The News Feed will have a Filter button that will affect the Food Ingredient News, Newest Additions to Regulatory Library, and Pending
Regulations elements. When the Filter button is selected, the Select Filters modal will appear, and this will allow the user to set the filters. The
selectable filters will be: market, regulation subject, regulation type, and regulation status. The values for these filters will be drawn from the
corresponding fields contained within the Food Ingredient Database. The number of filter values that the user can select should be limited only by
the number of possible values within each category. These values will then be compared against the corresponding values included in the Newest
Additions to Regulatory Library and Pending Regulations feeds and the tags from the stories in the blog. After the filters are selected by the user,
all stories within both the feeds and the blog that do not meet the selected conditions will be removed from the News Feed, leaving only those
items that meet the filter conditions. The filter values selected by the user will be listed in the Select Filter modal, and the user will be able to clear
these values either individually or all at once. Users will be able to set their selections as the system default by selecting a button located on the
Select Filters modal. A system default filter will have the function of being automatically loaded each time the News Feed is loaded. If there is not a
system default set, the News Feed will load unfiltered. However, once a system default is set, the News Feed will load filtered. This will occur even
upon the opening of new system sessions. Once a filter is selected as the default, the button will then change to allow the user to remove the
default condition from the filter.

The filters will use both AND and OR conditions. When a user selects values for two or more categories (i.e., market, regulation subject, regulation
type, and regulation status), an AND condition should be used. For example, if the market “Japan” and the regulation subject “flavorings” are
selected, then only regulations that have the values “Japan” AND “flavorings” in the corresponding Regulations Database fields should be
considered to meet the filter conditions. When a user selects two or more values within a category, then an OR condition should be used. For
example, if the markets “Japan” and “China” are selected, along with the regulation subject “flavorings”, then only regulations with the values
(“Japan” AND “flavorings”) OR (“China” AND “flavorings”) should be considered to meet the filter conditions.

The Select Filter modal will have a save button that allows the user to save the filter which they have selected. Upon hitting this button, a pop-up
window should appear asking the user to name the filter. Once this info is entered, the user will then save the filter, returning them to the Select
Filters modal. If the user selects a set of values that are already a saved filter, the saved filter name should appear under “Select Filters” in the
modal. In this case, upon hitting save, a pop-up window should appear notifying the user that this filter is already saved under the name “...”. The
user should then have a choice to edit this entry. Upon selecting this option, the user will be taken to the Saved Filters modal. The saved filter in
question should be centered on the screen and highlighted.
The Saved Filters modal will also be accessible from the Filters Modal, via a button in the top right corner. The Saved Filters modal will list the filter
name, date the filter was created, and a delete option justified to the left of the modal. To the right of modal, Set as Default/Clear as Default, View
Filter, and Select Filter buttons will be included. The View Filter button will return the user to the Select Filters page. Any changes made here will
be saved if the user hits the save button. The user will be prompted again to enter a name for the filter. However, in this instance, the name of the
saved filter will appear in the field. If the user does not edit the name, the saved filter will be overwritten with the new information. Before this
occurs, a warning modal should pop-up to alert the user that this will happen and to confirm that they want to do this. If the user does edit the
name, then the original filter will not be overwritten, and a new filter will be saved with the edited name as its name. From the Saved Filters modal,
if the user hits the Select Filter button, the modal will be closed, and the News Feed will be revised.
d. My Regulations:
My Regulations will be a stand-alone page that will be available under the Regulation Library heading of the Menu. Within the Regulation Library
and the two separate feeds of the News Feed, the user will be able to save each regulation. When this is done, the regulation will be added to My
Regulations.

Within the My Regulations page, the regulations that the user has selected will be listed in a columnar structure. This list will include the following
columns, drawn from the Regulations Database:
• Title
• Market
• Type
• Status
• Subjects
• Details [Expand/Collapse Button]
• Amendments [Expand/Collapse Button]
• Notes [Button that will open a modal]
• Remove [Button that will remove the regulation from My Regulations]

The regulations will be sorted by market, then type, then status, then name by default. However, the user will be able to sort by title, market, type,
and status. There will also be filters for the columns: market, type, status, and subjects. When the user selects the Notes button, a modal will open
in which the user can write and save notes in a text editor.

Each regulation saved to the My Regulations page, will automatically also save all amendments that are linked to the regulation to the My
Regulations page.

Underneath each regulation will be a details button that will maximize/minimize the full regulation details, as drawn from the Regulations
Database.

Underneath the details button will be an amendments button that will maximize/minimize all amendments. These amendments will be listed the
same as the other regulations in My Regulations, except that they will italicized. They will also have a details button that will maximize/minimize
the full regulation details, but there will be no amendments button.

By default, all details and amendments on the My Regulations page should minimized. If an amendment has been saved, while its corresponding
regulation has not been saved, then the amendment will appear as a top-level item. If an amendment has been saved independently from a
regulation which has also been saved, then the amendments for the regulation in question should appear maximized by default. However, no
other amendments and no details should be maximized by default. Amendments that have only been saved by default when a regulation was
saved should always be minimized by default.
i. Notes:
The Notes function will be accessible from a note icon the Newest Additions to Regulatory Library feed, the Pending Regulations feed, the
Regulatory Library, and the My Regulations page. When a note has been entered, the icon will appear filled-in. If no note has been entered, then
the icon will be grayed out.

The Notes function will take the form of a modal that will pop-up on the page in which the note icon was selected. The Notes function will have two
different types: the Personal Note and the Organization Note. The Personal Note will be tied to the specific user account. These notes will only be
accessible and editable by the specific user. The Organization Note will be tied to an organization account. These notes will be accessible and
editable by all users that are part of the organization account.

The Notes modal should be a text editor that allows the user to add or modify notes. By default, the note should not be editable, and the text editor
hidden to ensure that the note is not modified on accident.
The Notes modal will include an edit button. When the user selects this, the text will become editable and the text editor will appear. The notes
should automatically save. The user should be able to exit by either the text editor and return to the view-only mode or by closing the Notes modal
altogether.
e. Menu:
The Menu sidebar will be a simple directory of links to the different parts of the website. It should be located on the left of each page in the system.
The part of the system that the user is currently on should be highlighted on the menu.
3. Data Entry System

The Food Ingredient Center will require a simple Data Entry System that will consist of three pages (separated by tabs): Regulations, Markets, and
Filterable Values. The Data Entry System should have a login page so that user information can be logged and potentially stored with entered
data.

a. Regulations:
The Regulations tab will be where data entry for regulations, amendments, and WTO notifications occurs. The first selectable field will be a combo
box titled Regulation Type. This will have three options: regulation, amendment, and WTO notification. The selection made in this combo box will
then determine which fields are populated for the rest of the page. The fields for each regulations type are those outlined in section 2(a)(iii). There
should also be an auto-populated field after Regulation Type that holds the regulationID (or whatever the name of the regulation primary key is).
This field should be non-editable and greyed-out. It is only displayed for reference.

Following the fields mentioned above, the Regulations tab should also include a subform. The purpose of this subform is to list all market
regulations so that the regulatory analysts can enter the relevant RegulationID in the parent field. This subform will list all regulations for the
selected market. The subform should not list the market field, but will list the following fields: regulation title, publication date, effective date,
regulation subject, regulation status, parent regulation.

b. Markets:
The Markets tab will be where markets are created and managed. The first selectable field will be a combo box titled Market. This will be a list of
currently created markets. The regulatory analysts will be able to add values to this combo box.

Next to the market, will be a pair of radio buttons: Public and Non-public. Toggling between these will lead to a confirmation box. When moving
from Non-public to Public, the user will be asked: “This will make this market publicly available. Do you want to proceed?”. When moving from
Public to Non-public, the user will be asked: “This will make this market not publicly available. Do you want to proceed?”. By default, a newly
created market will be Non-public. Markets which are non-public will not be available on the Market Selection Page. The regulatory analysts will be
able to select non-public markets values and tags in the data entry system and the blogging system. However, regulations with a market value or
tag that is for a Non-public market will not appear in the news feeds until the market is made Public. If a market is moved from Public to Non-
public, any regulations with the market value of the now Non-public market will be removed from the news feeds. However, for the blog, both
Public and Non-public markets should be selectable tags. All market tags will appear in the blog, regardless of the public status of the market.

The Markets tab will also include the URL for the selected market’s page in the Regulation Library. When a market is non-public, this URL should
only be accessible to system administrators.

c. Filterable Values:
The Filterable Values tab will be where values can be added to the fields in the Regulations Library that the system filters are based on. These
fields are: regulation subject, language, and regulation status. These values should be listed in a combo box. The regulatory analysts should be
able to enter new values into these combo boxes.
4. Future Options

a. Remind Me Function:
Next to each regulation in the Pending Regulations News Feed and Regulation Library for which the value for effective date is a future date in the
Regulations Database, there should be an alert button. When the user clicks this button, a modal should pop-up. This modal will ask the user the
date that they would like to be reminded of the regulation’s effective date. They should manually enter the date, with a pop-up calendar available.
They must confirm before selecting to be reminded. After they have made their selection, an email will be sent to them reminding them of the day
that the regulation comes into force.

The email which they receive should follow a template with the details of the regulation, as well as whether it has a pending effective date or
comment deadline.

b. My Custom Reports Page:


Custom reports could be added to a future iteration of the system. This would be a page where analysts could upload and track custom reporting
projects that they complete for users. This page would function in a similar way to the My Regulations page, as it is a library of reports. Each report
would appear on its own line including the report title, the date of completion, the ability to download the latest version of the report, notes, a toggle
on/off switch for purchasing monitoring, and the date last updated including previous versions of the report. All fields would be entered and edited
by the analysts themselves. The page should also include a way for the user to contact us to discuss monitoring or purchasing reports. The page
will need a data entry system, or at the very least, a way to upload files to it.

You might also like