EPIC - Solution requirements

Owned by Robert Adach, created
Last updated: Mar 17, 2022
6 min read





Target release

Epic

Document status

DRAFT

Document owner

@Robert Adach

Business POC

Designer

Developers

QA



Goals

  • Definition of data elements and their relationship to each other

Background and strategic fit

The primary purpose of the L&R system is to categorize, document and display specific laws and regulations. In order to do this the system must be able associate data in a structured manner

Assumptions

  • All actions below should be able to be completed via a web-based interface.

  • The web-based interface must function without deviation in all ASWB supported browsers.

  • When deleting an item,

    • the system must use double-confirmation of intent before completing any action.

    • the system must delete all items “downstream” from the select item

      • e.g. If a top-level category is deleted, all associated sub-categories, attributes, and items will be deleted as well.

Requirements

Requirements are documented against four levels of importance

  • Must Have - the requirement must be part of the solution offered and will not be acceptable if missing. The requirement must either be offered as a standard feature, or via customization, or activated by configuration.

  • Should Have - the requirement is not required to be part of the solution but is wanted by ASWB staff to maximize the functionality of the solution. If this requirement is available via customization, approximate costing should be declared.

  • Nice to Have - the requirement is not required to be part of the solution, and the availability will not be considered as a determining factor in solution section. If this requirement is available via customization, approximate costing should be declared.

  • Must Not Have - the requirement must not be part of the solution. If the requirement can be met via customization, approximate costing should be declared.

  • Should Not Have - the requirement is not required to be met, but is preferred by ASWB staff. If the requirement can be met via customization, approximate costing should be declared.

Title

User Story

Importance

Notes

Title

User Story

Importance

Notes

1

System

As a system, I must be developed publicly available (and/or with licenses) frameworks and coding languages

Must Have

Allows ASWB to switch developers in the future if needed.

2

System

The system must be able to be hosted on a Microsoft based technology stack (Azure)

Must Have

Only necessary if ASWB is going to host and/or support the site.

3

System

Whenever possible, the system should support the configuration of items, settings, values vs. customization of code.

Should have

 

4

System

The system must support the input, saving and rendering of all UTF-8 encoded characters

Must Have

Ensures that legal and other non-standard symbols like are supported.

5

System

As a system, I must support different levels of access for internal users

Must Have

 

6

System

As a system, I should support different levels of access to external users

Should have

 

7

System

As a system, I should allow for setting specific permission to access levels

Should Have

 

8

System

As a system, I should support Single sign-on functionality with Azure Active Directory and OAuth 2.0

Should Have

 

9

System

As a system, I must have different access points for internal and external users

Must Have

 

10

System

As a system, I must communicate with browsers and internal infrastructure via secure transport methods.

Must Have

 

11

System

As a system, I must be able to show authorized users performance metrics of the site for declared/defined periods of time (Last Hour, Today, Yesterday, Last 7 days, This Month, Custom date range)

Must Have

Uptime, Processor Usage, # of inbound requests, # of outbound requests

12

Administration

As a user, I should be able to edit top-level categories

Must Have



13

Administration

As a user, I should be able to delete top-level categories

Must Have

  • System must use double-confirmation of intent before completing deletion

  • System must delete all related data items

14

Administration

As a user, I should be able to add sub-level categories

Must Have

 

15

Administration

As a user, I should be able to edit sub-level categories

Must Have

 

16

Administration

As a user, I should be able to delete sub-level categories

Must Have

  • System must use double-confirmation of intent before completing deletion

  • System must delete all related data items

17

Administration

As a user, I should be able to add identifiers

Must Have

  • Name

  • Is Active

  • Type of data (drop-down, number, single line text box, multiline text box)

18

Administration

As a user, I should be able to edit identifiers

Must Have

 

19

Administration

As a user, I should be able to delete identifiers

Must Have

  • System must use double-confirmation of intent before completing deletion

  • System must delete all related data items

20

Administration

As a user I should be able to add new attributes selection values for a specific identifier

Must Have

  • Applies to list of values only and not text fields

21

Administration

As a user I should be able to edited existing attributes selection values for a specific identifier

Must Have

  • Applies to list of values only and not text fields

22

Administration

As a user I should be able to delete existing attribute selection values

Must Have

  • System must use double-confirmation of intent before completing deletion

  • System must delete all references from identifiers

23

Data Config

As a system, I must be able to store board specific attributes for each identifier

Must Have

 

24

Data Config

As a system, I must track the data type associated with an Attributes

Must Have

 

25

Data Config

As a system, I must allow attributes to be associated with list of values to be selected.

Must Have

 

26

Data Config

As a user, I must be able to associated an attribute with an identifier for each jurisdiction

Must Have

 

27

Data Config

As a system, I should allow users to select if an attribute is to be shown when no data exists

Should Have

 

28

Data Config

As a system, I should allow users to restrict an attribute to specific jurisdiction(s)

Should Have

 

29

Data Config

As a system, I must be able to support the input and rendering of formatted text

Must Have

  • The system should be configured with standard styles

    • 5 levels of bulleted headings

    • 5 levels of numbered headings

    • Bold

    • Italic

    • Normal (standard formatting)

30

Data Config

As a system, I should be able to “clean” data pasted from Microsoft Word or Excel

Should Have

 

31

Data Config

As a system, I must allow ASWB staff to make updates to multiple attributes at once

Must Have

 

32

Data Config

As a system, I should offer spelling and grammar checks for all inputted items

Nice to Have

 

33

Data Config

As a system, I should support the creation and tracking of a custom spelling Dictionary that does not utilize the browser built-in functionality

Nice to have

 

34

Relationships

As a user I should be able to associate a sub-category to a top-level category or a sub-level category

Must Have

  • A sub-category may only be have one parent category

  • A sub-category may have one or more children category(ies) associated with it.

35

Reporting

As a system, I should track and report the latest date any element on the report was update

Should Have

Allows us to have a “Last Updated” line on the report.

36

Reporting

As a user, I should be able to see the number of items an attribute is currently used

Must Have

This will allow users to know if the attribute is currently in use before editing/deleting it

37

Reporting

As a system, I must be able to store report templates which will be populated based on filter criteria

Must Have

 

38

Reporting

As a system, I must be able to expose reports to third-party websites

Must Have

 

39

Reporting

As a user, I should be able to pick from a list of predefined reports, and designate which jurisdiction(s) to show.

Must Have

  • Details of predefine reports will be developed prior to start of development

  •  

40

Reporting

As a user, I should be able to select one or more top-level categories, sub-categories and identifiers on a report and select with jurisdiction(s) the report data should be filtered on

Must Have

The system will use a linked list configuration so that sub-categories are only shown if their parent category is selected.

41

Reporting

As an ASWB staff member, I must be able to perform ad-hoc queries of data

Must Have

 

42

Reporting

As a system, I must allow the export of report raw data in Excel format

Must Have

 

43

Reporting

As a system, I must allow the export of report raw data in XML format

Must Have

 

44

Reporting

As a system, I must allow the export of report raw data in JSON format

Must Have

 

45

Reporting

As a system, I must allow the export of reports in HTML format

Must Have

 

46

Reporting

As a system, I must allow the export of reports in PDF format

Must Have

 

47

Reporting

As a system, I must allow the exports of reports in Word format

Must Have

 

48

Reporting

As a system, I must provide ASWB staff with content metrics

  • # of views per report/dataset

  • Avg. time on report/dataset

  • # of times exported/dataset

  • User usage

    • Number of logins

    • Login Date/Time/IP

Must Have

 

Supporting Documents

Questions

Below is a list of questions to be addressed as a result of this requirements document:

Question

Outcome

Question

Outcome

Not Doing



Technical Review (IT)

Areas Affected