KAW SAMPLE Req Doc--Licensing v1

Kathleen Walsh SAMPLE REQUIREMENTS SPECIFICATION DOCUMENT

KAW SAMPLE Req Doc--Licensing v1.docx Page 1 of 43 Last Modified: 3-Aug-15 4:55 PM (Version: 294)

Company, LLC

Feature Requirements Doc

TrackID 12644: Licensing

Project: 1.5

Review Version 1

(Last Modified: 3-Aug-15 4:55 PM) (Version: 239)

Sample Document Notes

This document is intended to illustrate how requirements may be presented. In an Agile environment, this

feature would be spread across several sprints, likely as follows:

• Inactive Users

• License Key and compliance features

• Analytics



Revision History

Date Version Author Comments

150801 1 Kathleen First draft



Table of Contents

Revision History ...................................................................................................................................................................... 2

Contacts .................................................................................................................................................................................. 6

Review Notes .......................................................................................................................................................................... 6

Overview ................................................................................................................................................................................. 6

Open Issues (0) ........................................................................................................................................................................ 6

A1-General .............................................................................................................................................................................. 6

Scheduled System Actions .................................................................................................................................................. 6

Daily and Weekly Notification Emails ............................................................................................................................. 6

Subscription Emails ......................................................................................................................................................... 7

Single Signon ....................................................................................................................................................................... 8

C1-Shared ................................................................................................................................................................................ 8

Email Notifications and Subscriptions ................................................................................................................................ 8

Process Immediate Subscriptions ....................................................................................................................................... 9

Select User (Single-Select) .................................................................................................................................................. 9

Select Users/Groups (Multi-Select) ................................................................................................................................... 10

User Login ......................................................................................................................................................................... 12

D1-API ................................................................................................................................................................................... 14

User Management API ...................................................................................................................................................... 14

E1-Object Properties ............................................................................................................................................................. 14

Customer Application Configuration Settings................................................................................................................... 14

Documents ........................................................................................................................................................................ 14

Groups ............................................................................................................................................................................... 15

Role Permissions ............................................................................................................................................................... 15

Users ................................................................................................................................................................................. 15

Workflow Tasks ................................................................................................................................................................. 16

F1-Admin ............................................................................................................................................................................... 16

General Requirements ...................................................................................................................................................... 16

Shared Requirements ....................................................................................................................................................... 16

Select Users ................................................................................................................................................................... 16

Customer Config Settings .................................................................................................................................................. 17

Group Creator ................................................................................................................................................................... 17

Group Details Dialog ..................................................................................................................................................... 17



License Manager ............................................................................................................................................................... 18

GUIs ............................................................................................................................................................................... 18

Functions ....................................................................................................................................................................... 21

Transfer Data Manager ..................................................................................................................................................... 22

Functions ....................................................................................................................................................................... 22

User and Group Management .......................................................................................................................................... 22

User Manager.................................................................................................................................................................... 24

GUIs ............................................................................................................................................................................... 24

Functions ....................................................................................................................................................................... 26

User Import/Export ........................................................................................................................................................... 31

G1-Customer Application ...................................................................................................................................................... 31

H1-Employee Application ..................................................................................................................................................... 31

Shared Requirements ....................................................................................................................................................... 31

Document Delete .......................................................................................................................................................... 31

Document Properties Check ......................................................................................................................................... 32

Document Publish ......................................................................................................................................................... 34

Document Submit ......................................................................................................................................................... 34

Save from Edit ............................................................................................................................................................... 34

Content Manager Tab ....................................................................................................................................................... 34

Functions ....................................................................................................................................................................... 34

Content Editor ................................................................................................................................................................... 35

Functions ....................................................................................................................................................................... 35

I1-Envion, Install, OOB .......................................................................................................................................................... 36

Upgrade ............................................................................................................................................................................. 36

Database and Data ........................................................................................................................................................ 36

J1-Performance ..................................................................................................................................................................... 36

K1-Analytics ........................................................................................................................................................................... 36

License Analysis ................................................................................................................................................................. 36

QA Notes ............................................................................................................................................................................... 40

Object User Properties that do NOT need to be Active .................................................................................................... 40

User searches that search ALL users .................................................................................... Error! Bookmark not defined.

Timing Issues ..................................................................................................................................................................... 41

Appendix A: Conventions ...................................................................................................................................................... 41





Contacts

Position/Responsibility Person

PRD/FRD Owner Kathleen Walsh

Product Manager John Smith

Review Notes

• Yellow highlighting = new features and functionality

• Track Changes is used to indicate changes from previous review version.

• Screen shots in this document may only be visible in Page view mode, not Normal/Draft mode.

• The requirements in FRDs are delta requirements. In some cases, existing requirements are not

included in their entirety (to save space for very long requirements such as field/function lists and

object properties). Instead, only new or changed items are listed.

◊ If an existing item is to be modified, it is included with the modification.

◊ If an existing item is to be removed, it is included and struck out.

◊ If an existing item is remaining as is, it is not included.

Overview

Company is trying to audit customers and ensure they are in compliance with their licenses. To make this

easier, on both the Customers and Company, some features need to be added to the product.

Open Issues (0)

This section tracks issues preventing this feature and document from being approved.

A1-General

SCHEDULED SYSTEM ACTIONS

Daily and Weekly Notification Emails

A1333. Send Daily and Weekly Notification Emails shall function as follows:

1. System processes the notifications creating a single email for each Active user who has

chosen one or more Daily or Weekly notification options.

System sends one email per user and includes each item only once, even if it meets

multiple conditions.

For example, if the user elected to receive

- Assigned, Daily

- Owner, Daily

- Supervisor, Weekly

Each day at the configured Email Notification Time the system checks the daily

notifications. For any item that matches either condition, the System generates one



email containing a list of those items.

Each Sunday at the configured Email Notification Time, the system does the same thing

for the daily subscriptions but also checks the weekly subscription conditions so once a

week users with daily and/or weekly subscriptions receive a single email for all their

daily/weekly subscriptions.

2. The system shall include the following in the email; in all cases, the section is included

only if the user has requested the applicable notification in their profile:

Section Included

Document Available Included for each document task that does not have an

Owner and is available to this user based on user profile and

workflow configuration.

Document Assigned Included for each task item assigned to the user (user was

made Owner).

Document Overdue Included if the user is the document supervisor AND the

document is overdue (current date/time > submitted

date/time + overdue configuration value).

Subscription Emails

A1108. Process Scheduled Subscriptions: At the scheduled date and time for Daily and Weekly

Subscriptions:

1. System creates a list of:

- Documents that have been published (Publication Status = Published) since the

previous check for Daily/Weekly Subscription Notifications.

- Documents for which Categories were added since the previous check for Daily/Weekly

Subscription Notifications.

- Documents whose titles changed since the previous check for Daily/Weekly

Subscription Notifications.

2. For each Active user, if the user has at least one Daily/Weekly subscription:

2.1. For each Document in the list:

2.1.1. System verifies the User's Access Levels match Document's Access Levels

for at least one slice.

2.1.1.1. If not, the System removes the Document form the list and

continues to check the next Document.

2.1.1.2. If so, the System continues with the next check.

2.1.2. System verifies the Document meets at least one subscription's conditions.

A Document must meet ALL conditions in a single subscription; conditions

are checked:

- Document ID: The Document is identified explicitly in the subscription

- Language condition: The Document's language is the same as the

condition.



- Category conditions: Categories in single subscription are ANDed.

Document must contain all specified Categories for notification to be

triggered.

- Text condition: The Document Title contains all strings in the condition.

2.1.2.1. If not, the System removes the Document form the list and

continues to check the next Document.

2.1.2.2. If so, the System continues with the next check.

3. If there is still at least one item in the list, the System sends the user a single email

containing a list of all the items using the "Subscription: Daily" OR "Subscription:

Weekly" template per the Send Notifications and Subscriptions requirement (A1082).

Each item shall be included only once, even if it meets multiple conditions.

For example, if the user has 4 subscriptions, 2 daily and 2 weekly.

Each day the system checks the 2 daily subscriptions. For any item that matches either

subscription's conditions, the system generates one email containing a list of all items.

Each week, the system does the same thing for the daily subscriptions but also checks

the weekly subscription conditions. If there is one or more items that match the daily

conditions and one or more that match the weekly conditions, the user is sent 2 emails

(one daily and one weekly).

SINGLE SIGNON

There are no changes to single signon requirements; however, it should be tested to ensure Single Signon

obeys all standard Login rules (inactive users can’t login, user permissions/roles adhered to).

C1-Shared

EMAIL NOTIFICATIONS AND SUBSCRIPTIONS

C1082. Send Notifications and Subscriptions shall function as follows:

User Action System Response

1. (called) 1. System verifies SMTP status is valid (per startup).

2. System identifies list of users to receive emails.

2.1. Only Active Users are considered.

2.2. For Email Notifications:

2.2.1. The appropriate users are identified in the Email Notification

requirements. Unless otherwise stated, the Notification is

sent only to users who have chosen to receive it in their

User Profile.

Note that some Options apply to multiple Notifications;

selecting it causes the user to be subscribed to all of them.

2.2.2. Each user receives only one email per event, even if they

qualify as more than one of the recipients (e.g., same user

is Supervisor and Owner).



2.3. For Subscriptions, the users are identified by the calling

requirement.

3. For each identified recipient, the System sends a separate email.

System creates the email from the appropriate template configuration

and the user's Email Language preference.

Email content shall be plain text with the exception of the hyperlink

inserted using one of the supported url variables.

System inserts values and hyperlinks into the email body per the

template variables.

4. System returns to calling requirement.

Alternatives

1. Alt: Invalid Status

In Response 1, if the status is not valid, the System verifies the configured email SMTP

server is valid.

1.1. If the SMTP server is not valid

1.1.1. System logs error: "SMTP server is not valid".

1.1.2. System repeats the SMTP server validation every 10 seconds until it is

found to be valid and stores the status.

1.2. If the SMTP server is valid, the System continues with Response 2.

2. Alt: Template DNE

In Response 1.3, if a template does not exist for the user's selected Language, the

System uses the English template.

PROCESS IMMEDIATE SUBSCRIPTIONS

C1359. Process Immediate Document Subscriptions shall function as follows:

There are no changes to this requirement; however, it calls a requirement with a change

(C1082)—to only send Email Notifications to Active users and that must be implemented

and tested.

SELECT USER (SINGLE-SELECT)

C1196. Single-Select Users shall function as follows:

Documentation Note: For Accept Suggestion, to make new document available to all users,

click OK on this dialog without searching for or selecting any user.

Pre-condition: A page with this function included is displayed.


1. User fills in fields.

2. User selects "Find".

1. System verifies that at least one field contains a search

string.

2. System searches for Active users that start with the



entered text AND any restrictions passed in from the

calling requirement.

If "Limit to users with Document rights" is checked, the

users are restricted based on their document rights and

the document properties. (See the User Rights to

Document requirement (3060).)

If the user entered *, system returns all users that match

restrictions.

3. System displays the found users.

3. User selects a name in

the results list.

4. System selects the name and de-selects any previously

selected name.

4. User selects "OK". 5. System returns selected user to the calling requirement.


Alternatives

1. Alt: Cancel

At any point if the user selects "Cancel":

1.1. System closes the Select User dialog.

1.2. System returns to calling requirement.

2. Alt: Fields Blank

In Response 1, if all fields are blank:

2.1. System displays: "Enter value for First Name, Last Name or User Name" with

action "OK"

2.2. User selects "OK".

2.3. System closes error message.

3. Alt: No Users Found

In Response 3, if no Users were found, the System displays "No Users found." in place of

the Users list.

4. Alt: Next Group

In Results list, if the user selects "Next", the system displays the next group of Users.

5. Alt: Previous Group

In Results list, if the user selects "Previous", the system displays the previous group of

Users.

6. Alt: View User

In Results list, if the user clicks user name, the system functions per the Edit User

requirement (F1248).

SELECT USERS/GROUPS (MULTI-SELECT)

C1198. Select Users/Groups shall function as follows:




1. (called) 1. System displays the Select Users/Groups dialog with tabs

requested by calling requirement. See the Select

Users/Groups dialog (C1199).

If both tabs are included, the Find Users tab is in focus.

2. User enters text in any

field.

3. (optional) User changes

Within selection.



string.

3. System searches for Users or Groups:

3.1. System limits search to Active Users.

3.2. System limits search to Groups with at least one

Active User.

3.3. If text is entered in a name field, system finds

users or groups with names that start with the

entered text.

3.4. If user entered *, the System returns all Users or

Groups.

3.5. If within value is selected, the System limits

returned Users to those with Roles of the selected

type and returned Groups to those where Type =

select value.

4. System displays the found Users or Groups.

5. User checks a name in

the results list.

5. System adds the selected user or group to the Selected

list.

6. User selects "OK". 6. System stores the selected users (they are not actually

saved until the user saves the parent object).


Alternatives

1. Alt: Cancel

At any point if the user selects "Cancel":

1.1. System closes the Select Users/Groups dialog.

1.2. System returns to calling requirement.

2. Alt: Select Tab

At any point, if the Users selects a tab. System changes the display to the selected tab's

GUI. If this is the first time the tab is displayed (in this instance of the dialog's use), the

fields are set to their default values; otherwise, previously entered data is displayed.

3. Alt: View User

At any point, if the user clicks a User name from the results or selected list, the System

functions per the Edit User requirement (F1248).

4. Alt: View Group

At any point, if the user clicks a Group name from the results or selected list, the



System functions per the View Group requirement (F1250).

5. Alt: Uncheck Name

At any point, if the user unchecks name in results list, the System removes the user

from the Selected list and unchecks the check box in the results list.

6. Alt: Remove

At any point if the user selects remove icon, the System removes the user from Selected

list and unchecks the check box in the results list.

7. Alt: Fields Blank


7.1. System displays:

If on User tab: "Enter value for First Name, Last Name or User Name." with

action "OK"

If on Group tab: "Enter value for Group Name or Owner User Name." with action

"OK"



8. Alt: No Groups Found

In Response 3, if no Groups were found, the System displays "No Groups found." in

place of the Groups list.

9. Alt: No Users Found

In Response 3, if no Users were found, the System displays "No Users found." in place of

the Users list.

USER LOGIN

C1366. User Login shall function as follows:


1. (called) 1. System displays the appropriate Login Page:

- Administrator: Administrator Login Page (F1315)

- Employee: Employee Login Page (H1196)

- Customer: Customer Login Page (G1007)

2. User enters text in

fields.

3. User selects "Login".

2. System verifies the user name is valid.

3. System verifies the user profile Authenticate Externally =

No.

4. System verifies the user is Active.

5. System verifies the password is valid.

6. If remember me is selected, the System remembers the

user's login information.

7. If remember me is not selected, the System clears any

previously remembered login information.

8. System verifies user's Password Change Required flag = No.

9. System functions per the Log User In requirement (C1369).




Alternatives

Login error: "User name and password are not valid. Please try again."

1. Alt: Clear

At any point if the user selects "Clear", the System clears the User Name and Password

fields and places the cursor in the User Name field.

2. Alt: Register Now

At any point if the user selects "Register Now":

2.1. System omits all remaining Responses.

2.2. System functions per the Register Now requirement (G1009).

3. Alt: Forgot

At any point if the user selects "Forgot your user name or password?"


3.2. System functions per the Forgot Password requirement (G1113).

4. Alt: Invalid Name

In Response 2, if the user name is invalid, the System displays the login error.

5. Alt: Inactive User

In Response 4, if the user is Inactive:

5.1. System omits remaining Responses.

5.2. System displays: “Your account has been de-activated. Please contact the

System Administrator.” with the Action “OK”.

5.3. User selects “OK”.

5.4. System closes error dialog.

6. Alt: Invalid Password

In Response 4, if the password is invalid, the System displays the login error.

7. Alt: Password Change

In Response 5, if the Password Change Required flag = Yes:

7.1. System functions per the Change Password requirement (C1217).

7.2. System sets user's Password Change Required flag = No.

7.3. System continues with Response 6.

C1369. Log User In shall function as follows:


1. (called) 1. System creates user profile from User record and all Groups and Roles

to which user belongs.

2. System verifies user has necessary permission to access the

application (see C1369.1).

3. System updates user’s Last Login Date.




Alternatives

1. Alt: No application access

In Response 6, if the user does not have access to this application, the System replaces

the Login Page with a page with the message: "Sorry, you do not possess the

appropriate authorization permissions to access this page."

D1-API

USER MANAGEMENT API

There are no changes to the specific requirements for the following, but they must all handle the new

properties of the objects:

• Users

◊ createUser

◊ importUsers

◊ updateUsers

◊ getUser

E1-Object Properties

CUSTOMER APPLICATION CONFIGURATION SETTINGS

E1312. Customer Application Configuration Settings shall include the following:

Heading

Area

Property Qty Required

/

Optional

Description, Values, and

Restrictions

General

Settings

Anonymous User

name

1 Optional Username of an anonymous

user.

Valid values: Active user

DOCUMENTS

E1144. A Document shall have the following properties:

Property Qty Required

/ Optional

Description, Values, and

Restrictions

Audited

Supervisor 1 Required User currently assigned as the

Document's Supervisor.

Valid value: Active user.

Yes



GROUPS

E1293. A Group shall have the following properties:

Property Qty Required /

Optional

Description, Values, and Restrictions

Owner 1 Required User assigned as the Group's owner.

Valid value: Active user with "Own Groups"

permission

Supervisor 0 or 1 Optional User assigned as the Group Supervisor.

Valid value: Active user with "Supervise

Groups" permission

ROLE PERMISSIONS

E1298. The System shall provide the following Permissions:

Admin = Available for Roles where Type = Administrator

Emp = Available for Roles where Type = Employee

Cust = Available for Roles where Type = Customer

Permission Name

Description Category Admin Emp Cust

License Manager Users with this permission can access to the License Manager screen in Administrator.

Users have access to all functions except change license key which is controlled by a separate permission.

Admin Yes No No

Change Licenses Key

Users with this permission can access to the License Manager screen in Administrator, including the ability to change the license key.

Admin Yes No No

USERS

E1304. A User shall have the following properties:


Optional

Description, Values,

and Restrictions

Copied Change

take

affect…

Active 1 Required Indicates if the user is

Active or Inactive.

Valid value, one of the

following:

• Active (default)

• Inactive

Y On next

login



Employee

License Type

1 Required Indicates if the user has

a Named or Concurrent

Employee license.

Valid value, one of the

following:

• Concurrent

• Named (default)

Y On next

login

Last Login

Date

1 Optional;

System

Assigned

The date the last time

the user logged into any

Product application by

any means.

N n/a

WORKFLOW TASKS

E1145. A Workflow Task shall have the following properties:


Optional

Description, Values, and Restrictions Audited

Owner 1 Optional User currently assigned as the editor or

reviewer of this document.

Valid value: Active User

Yes

F1-Admin

GENERAL REQUIREMENTS

F1400. Administrator Home page shall include:

GUI Element Description Included/ Enabled

License Manager Provides access to the

License Manager page.

Always included

Enabled only if the user has “License Manager”

or “Change License Key” permission.

All existing

contents remain

as is

SHARED REQUIREMENTS

Select Users

F1096. Select Users shall function as follows:

There is no change to this requirement; however, there is to the associated GUI (F1097).

This requirement is included here so the change is implemented and tested.



Select User Dialog

F1097. The Select User dialog shall contain:

GUI Element Description Included/Enabled

Function:

Cancel

Provides the ability to close the dialog and

cancel the changes.

Functions per the Select User requirement

(F1096).

Always included

Always enabled

Function: OK Provides the ability to close the dialog and

store the selections.


(F1096).

Always included

Always enabled

Function: Open

User Profile

Provides the ability to open the select User's

profile for editing.


(F1096).

Included if user has

"Manage Users"

permission.

Always enabled if included

User List List of users list of users in the format: first-

name last-name (user-name) sorted by

displayed name.

Only users where ALL of the following are true

are included:

• Are Active

• Meet the conditions set by the calling

function.

List is single- or multi-select (radio buttons or

check boxes) as set by the calling function.

Always included

Always enabled

CUSTOMER CONFIG SETTINGS

F1131. Manage Customer Application Configuration Settings shall function as follows:

Pre-Condition: Advanced Tasks manager page is displayed.

There are no changes to this requirement; however, it calls the General Save requirement

which checks valid properties. Therefore, checks for new property requirements need to be

implemented and tested.

GROUP CREATOR

Group Details Dialog

Functions

Edit Group

F1110. Group Edit shall function as follows:

There are no changes to this requirement; however, it calls the General Save requirement



which checks valid properties. Therefore, checks for new property requirements need to be

implemented and tested.

LICENSE MANAGER

F1401. License Manager shall function as follows:

Pre-condition: User is logged into Administrator with permission to this feature.


1. From Administrator Home page, the

user selects License Manager.

1. System displays the License Manager

page.

2. User selects “Close”. 2. System returns to the Administrator

Home Page.

Alternatives

1. Alt: Change Key: If the user selects “Change Key”, the System shall function per the

Change License Key requirement (F1404).

2. Alt: View Users: If the user selects any “View Users” function, the System shall

function per the View Licensed User requirement (F1405).

GUIs

License Manager Page

F1402. The License Manager page shall include:

GUI Element Description Included/

Enabled

License Key Displays the current license key. Always included

Read-only

Employee Named

section

Displays information on Employee Named

license use.

See the Employee Named Section requirement

(F1402.1).

Always included

Read only

Employee

Concurrent Section

Displays information on Employee Concurrent

license use.

See the Employee Concurrent Section

requirement (F1402.2).

Always included

Read only

Customer

Concurrent Section

Displays information on Customer Concurrent

license use.

See the Customer Concurrent Section

requirement (F1402.3).

Always included

Read only



Function: Close Provides the ability to close the page.

Functions per the License Manager requirement

(F1401).

Always included

Always enabled

F1402.1. The Employee Named Section shall include the following rows:

GUI Element Description Included/

Enabled

% used The percentage of available licenses

in use.

% used = In Use / Available

Always included

Read-only

Available The number of licenses available

based on the license key.

Always included

Read-only

In Use The number of licenses in use.

This is the number of Active Users

where Employee License Type =

named.

Always included

Read-only

Function: View

Users

Provides the ability to view a list of

users with this type of License.

Functions per the License Manager


Always included

Always enabled

F1402.2. The Employee Concurrent Section shall include the following rows:


Maximum Last

3 months

Over the past 3 months, the

maximum number of concurrent

licenses used at any time.

Always included

Read-only

Average Last 3

months


average number of concurrent


To calculate average, the System

shall TBD: total number of users

logged in each day/Number of

Days .

Always included

Read-only



Always included

Read-only

Function: View

Users




Always included

Always enabled




F1402.3. The Customer Concurrent Section shall include the following rows:


Maximum Last

3 months


maximum number of concurrent


Always included

Read-only

Average Last 3

months


average number of concurrent


To calculate average, the System

shall TBD: total number of users

logged in each day/Number of

Days .

Always included

Read-only



Always included

Read-only

Function: View

Users





Always included

Always enabled

Change License Key Dialog

F1406. The Change License Key dialog shall include:


New Key Text entry field for the new license key. Always included

Always enabled

Function: Save Provides the ability to apply the new key.

Functions per the Change License Key


Always included

Always enabled

Function: Cancel Provides the ability to close the dialog

without changing the key.

Functions per the Change License Key


Always included

Always enabled

User License List Page

F1403. The User License List shall include:




Title The screen title depends on the list being

displayed:

• Employee Named Users

• Employee Concurrent Users

• Customer Concurrent Users

Always included

Read-only

User The full name of the user. Always included

Read-only

Last Login The date and time the user last logged

in.

Always included

Read-only

Function: View

User

Provides the ability to view the user

profile (in read-only mode).

Functions per the View User License List


Always included

Always enabled

Function: Close Provides the ability to close the screen.

Functions per the View User License List


Always included

Always enabled

Functions

F1404. Change License Key shall function as follows:


1. (called) 1. System displays the Change License Key dialog (F1406).

2. User enters new

license key.

3. User select “Save”.

2. System verifies key is valid.

3. System verifies the current number of Active users where

Employee License Type = Named does not exceed the

number allowed by the new license key.

4. System save the new key.

5. System closes the dialog.

6. System updates the License Manage page.


Alternatives

1. Alt: Cancel:

At any point, if the user selects “Cancel”:

1.1. System omits remaining responses.

1.2. System returns to the calling requirement.



F1405. View user License List shall function as follows:


1. (called) 1. System displays the License Manager page.

2. User selects

“Close”.

2. System closes the screen.


Alternatives

1. Alt: View User:

At any point, if the user selects “View User”:

1.1. System opens the User Profile screen in read-only mode.

1.2. System functions per the View User Profile requirement (C1500).

TRANSFER DATA MANAGER

Functions

Download File

F1196. Download File shall function as follows:

Since user selections on this screen can be made in any order and done/undone, the user

actions/system response are more "if the user does this, the system does this" than "the

user must do this in this order".

Pre-Condition: Transfer Data manager page is displayed.

There are no changes to this requirement; however, because there are changes to object

properties, this function must be modified to handle the new properties.

Upload File

F1197. Upload File shall function as follows:

Pre-Condition: Transfer Data manager page is displayed.

There are no changes to this requirement; however, because there are changes to object

properties, this function must be modified to handle the new properties.

This includes validation checking.

USER AND GROUP MANAGEMENT

F1013. Find People shall function as follows:

Pre-condition: Admin home page is displayed with this menu and function included and

enabled.

There are no changes to this requirement; however, it references the following which have

changed:

- Users & Groups finder dialog (F1023) no longer has the Within field

- Find Users & Groups requirement (F1022)



F1016. Find My Groups shall function as follows:

Pre-condition: Admin home page is displayed with this menu and function included and

enabled.

There are no changes to this requirement; however, it references the following which have

changed:

- Users & Groups finder dialog (F1023) no longer has the Within field

- Find Users & Groups requirement (F1022)

F1022. Find Users & Groups shall function as follows:

Note: Overlaps C1198—difference is "select" function and Select list.

Note: Since neither find action is any more likely than the other, both are presented as

standard options instead of one being an alternative.


1. (called)

Find Users Tab


field.



string.

2. System searches for Active Users that match the entered

criteria (Username, First Name, and Last Name; name

searches are case insensitive and partial matches from

beginning of name).

If user entered *, system returns all users that match

restrictions.

3. System displays the found Users.

Find Groups Tab


field.



string.

5. System searches for Groups that match the entered

criteria (Owner's Username and Group Name; name

searches are case insensitive and partial matches from

beginning of name).

6. System displays the found Groups.

Alternatives

1. Alt: Select Tab: At any point if the user selects a tab, the System displays the tab. If

this is the first time the tab is displayed (in this instance of the dialog's use), the fields

are set to their default values; otherwise, previously entered data is displayed.

2. Alt: Show All Users: At any point on the Find Users tab if the user selects "Show All", the

System displays all users.

3. Alt: Show All Groups: At any point on the Find Groups tab if the user selects "Show All",

the System displays all groups.

4. Alt: Edit User: At any point on the Find Users tab if the user selects User. System



functions per the Edit User requirement (F1248).

5. Alt: Select Group: At any point on the Find Groups tab if the user selects Group. System

functions per the Select Group requirement (F1151).

6. Alt: All Fields Blank:


6.1. System displays: "Enter value for First Name, Last Name or User Name" with

action "OK"



7. Alt: No Users Found: In Response 4, if no Users are found the system displays "No Users

found." in place of the Users list.

8. Alt: No Groups Found: In Response 9, if no Groups are found the system displays "No

Groups found." in place of the Groups list.

USER MANAGER

GUIs

Profile Editor Screen

F1249. Profile Editor screen shall contain the following tabs:

This screen is used in several places within the Product. This requirement identifies which

tabs are included or not in each location.

Tab Description Admin Included Employee Edit Profile Included

Customer Edit Profile Included

Customer Register Included

Subscriptions See Content Subscriptions Tab.

If ALL the following are true:

• User is Active.

• User has been saved at least once.

• User profile includes email address.

If user profile includes email address.

If user profile includes email address.

Never

Profile Data See Profile Data Tab.

Always; for new users the tab itself is not there; however, only some data on it is included.

Always Always Always (though tab itself is not there; only data on it is included).

Preferences See Preferences Tab.

If ALL of the following are true:

• User has been saved at least once.

• User is Active.

Included only for existing Users

Included only for existing Users

Never



Profile Data Tab

F1263. Profile Data Tab shall contain:

Field Description Admin Enabled/ Included

Employee Edit Profile Enabled/ Included

Customer Edit Profile Enabled/ Included

Customer Register Enabled/ Included

(all other

fields remain

as is)

Inactive Check box that

indicates if user

is Inactive.

Always

included

Always

enabled

Never Never Never

Last Login Date user last

logged in.

Always

included

Read-only

Never Never Never

Search User Page

F1411. Search User Page shall include:

F1411.1. Search Area shall include:


(all existing

elements shall

remain as is)

Last Login

From / To

Date range fields with calendar

selector.

Always included

Always enabled

Employee

License Type

Drop-down list containing the

following values:

• Any

• Concurrent

• Named

Always included

Always enabled

F1411.1. Search Area shall include:


(all existing

elements shall

remain as is)



Function: Make

Active

Provides the ability to make the

selected users Inactive.

Functions per the Make Users

Active requirement (F1413).

Always included

Enabled only if BOTH of

the following are true:

• User has “Manage

Users” permission.

• One or more users

are selected.

Function: Make

Inactive

Provides the ability to make the

selected users Inactive.

Functions per the Make Users

Inactive requirement (F1414).

Always included






are selected.

Function:

Change to

Named

Provides the ability to change

the Employee License Type of

the selected users.

Functions per the Change

License Type requirement

(F1412).

Always included






are selected.

Function:

Change to

Concurrent

Provides the ability to change

the Employee License Type of

the selected users.

Functions per the Change

License Type requirement

(F1412).

Always included






are selected.

Functions

Save User

F1265. User Save shall function as follows:


1. (called) 1. System functions per the General Save requirement (C1219).

2. System verifies that Password and Re-enter Password entries match.

3. System verifies the user name does not contain any term from the

configured Community Content Alerts.

4. System verifies the alias does not contain any term from the

configured Community Content Alerts.



5. If the password was changed since last save, the System sets the

Password Reset flag = yes.

6. System verifies Inactive state was not changed to Inactive.

7. If User has at least one Role of Type = Employee AND Employee

License Type = Named AND the user is new OR Inactive state was

changed to Active.

8. If the profile photo was deleted, the System deletes the associated

file.

9. System saves user.

Though all properties are saved at this time (and displayed should the

profile be accessed during the user's current session), some changes

do not take effect immediately. See the User requirement (E1304)

for details on what take affect when.


Note: System does not remove any properties not explicitly removed by

the user editing the Profile. For example, even though notifications and

subscriptions require an email address, if the email address is removed,

the user's subscriptions and notifications remain. If an email address is

later added, those notifications and subscription settings are still valid.

Alternatives

1. Alt: Passwords Do Not Match:

In Response 2, if the password fields do not match:

1.1. System displays: "The entered passwords do not match. Please re-enter them."

with the action "OK"

1.2. Administrator selects "OK".

1.3. System returns to the Profile Editor dialog with the cursor in the Password field.

2. Alt: User Name has Content Alert Term:

In Response 3, if the user name contains a term from the configured Community

Content Alerts.

2.1. System displays: "You cannot use profane words in username. " with the action

"OK"



3. Alt: Alias has Content Alert Term:

In Response 3, if the alias contains a term from the configured Community Content

Alerts.

3.1. System displays: "You cannot use profane words in alias. " with the action "OK"



4. Alt: Active State Changed to Inactive:

In Response 6, if the Active State was changed to Inactive, the System verifies the user

User is not an Owner or Supervisor of any Group or Tasks:



4.1. If the User is not, the System continues with Response 7.

4.2. If the user is:

4.2.1. System omits remaining responses.

4.2.2. System displays: "This user is Owner or Supervisor of one or more items

and cannot be made inactive:"

<list of task/group names and reason>

with the action "OK"

Example:

Type Name Reason

Group Group1 Supervisor

Group Group2 Owner

Task Task1 Owner

Task Task2 Supervisor

4.2.3. User selects “OK”.

4.2.4. System closes error message.

5. Alt: Active State Changed to Active:

In Response 7, if all conditions are met, the System verifies that there is an available

Named Seat license (Available – Used > 0).

5.1. If there is not an available license:

5.1.1. System omits remaining responses.

5.1.2. System displays: The maximum allowed Named Licenses has been

reached. Please edit the user and make them Inactive or change License

Type.” With the action “OK”.

5.1.3. User selects “OK”.


5.2. If there is an available license:

5.2.1. System increases the number of Used Named Seat Licenses.

5.2.2. System continues with Response 8.

Search Users

F1410. Search User shall function as follows:


1. (called) 1. System displays the Search Users page.

2. User enters search criteria.

3. User select “Search”.

2. System verifies Last Modified Date From field is

earlier than To field.

3. System verifies Last Login Date fields are earlier

than or equal to today.

4. System displays search results.

4.1. If Last Login Date From field is blank but

the To date is not, the System searches

using for users where Last Login date is



before or equal to the To date.

4.2. If Last Login Date To field is blank but the

From field is not, the System searches for

users where Last Login date is equal to or

later than the From date.

4. User selects “Close”. 5. System returns to calling requirement.

Alternatives

1. Alt: Clear: If the user selects “Clear”, the system clears all the search criteria.

2. Alt: Change to Concurrent:

2.1. User selects one or more users. (These users may be on different pages.)

2.2. User selects “Change to Concurrent”.

2.3. System functions per the Change License Type requirement (F1412).

3. Alt: Change to Named:


3.2. User selects “Change to Named”.

3.3. System functions per the Change License Type requirement (F1412).

4. Alt: Delete:


4.2. User selects “Delete”.

4.3. System functions per the Delete Users requirement (F1418).

5. Alt: Make Active:


5.2. User selects “Make Active”.

5.3. System functions per the Make Users Active requirement (F1413).

6. Alt: Make Inactive:


6.2. User selects “Make Inactive”.

6.3. System functions per the Make Users Inactive requirement (F1414).

7. Alt: De-select All:

7.1. User selects “De-select All.

7.2. System unselects all users on all pages.

Change License Type

F1412. Change License Type shall function as follows:




1. (called) 1. System displays: “Are you sure you want to change the

License Type of all the selected Users to <new type>?”

with the options “Yes” and “No” (default)

2. User selects “Yes”. 2. System closed prompt dialog.

3. System displays progress dialog (see C1051) and updates

it as the process continues.

4. For each selected User:

4.1. System verifies the user exists.

4.2. System verifies the user is not locked.

4.3. System locks the user.

4.4. System changes the License Type of the users.

4.5. System updates the Last Modified Date.

4.6. System releases the lock on the user.

5. System verifies no errors occurred.

6. System updates progress dialog with completed message.

Alternatives

1. Alt: No

Instead of Action 2, if the user selects “No”

1.1. System omits remaining responses.

1.2. System closes the message dialog.

2. Alt: Cancel Progress

On the progress dialog, if the user selects "Cancel":

2.1. System completes processing of the current item.

2.2. System stops processing.

2.3. System continues with Response 5.

3. Alt: UserDNE

In Response 4.1, if the User does not exist:

3.1. System skips the User.

3.2. System continues with Response 4 for the next selected User. If all selected

Users have been processed, the System continues with Response 5.

4. Alt: User Locked

In Response 4.2, if the User already is locked:

4.1. System keeps track of the User and reason.

4.2. System skips the User.

4.3. System continues with Response 4 for the next selected User. If all selected

Users have been processed, the System continues with Response 5.

5. Alt: Errors Occurred

In Response 5, if any errors occurred:



5.1. System omits Response 6.

5.2. System closes progress dialog.

5.3. System displays:

"The following Users could not be updated:"

Title Reason

<user full name> <reason>

where <reason> is one of the following:

"Locked for editing."



Make Users Active

F1413. Make Users Active shall function as follows:

In a complete FRD, this requirement would be included; however, for this SAMPLE

document it is not. There are already other examples of similar requirements.

Make Users Inactive

F1414. Make Users Inactive shall function as follows:

In a complete FRD, this requirement would be included; however, for this SAMPLE

document it is not. There are already other examples of similar requirements.

USER IMPORT/EXPORT

F1505. Import Users shall function as follows:

There are no changes to this requirement; however, because there are new properties for

Users and Roles, utility must be modified to handle the new properties.

This includes validation checking.

F1504. Export Users shall function as follows:

There are no changes to this requirement; however, because there are new properties for

Users and Roles, utility must be modified to handle the new properties.

G1-Customer Application

Changes to Customer application are covered by shared requirements.

H1-Employee Application

SHARED REQUIREMENTS

Document Delete

H1201. Doc Delete shall function as follows:



and tested.



Document Properties Check

H1103. Document Properties Check shall function as follows:

There is no specific change to this requirement; however, due to property condition changes,

the functionality is changed for Owner and Supervisor = Active User (Response 6).


1. (called) 1. System verifies the Document’s Template has not been deleted.

2. System verifies the Document’s Template has not been changed.

3. System verifies that all selected Categories still exist.

4. System verifies that all selected Access Levels still exist.

5. System verifies that all required properties are set.

6. System verifies the document contains at least non-blank Area.

7. System verifies all entered dates are in the correct format.

8. System verifies the Review Date is later than today’s date.

9. System verifies the Archive Date is later than today’s date.

10. System verifies the Supervisor is not blank.

11. System returns to the calling requirement.

Alternatives

1. Alt: UT Deleted

In Response 1, if the Template has been deleted AND:

1.1. Document has been saved before, the System functions per the Assign New

Template requirement (H1014).

1.2. Document has not been saved before:

1.2.1. System displays: "Template has been deleted; Document cannot be

saved." with the action "OK"

1.2.2. User selects "OK".

1.2.3. System closes the error message.

2. Alt: UT Modified

In Response 2 if the template has been modified:


2.2. System displays: "Template has been modified. Document will be updated for

new Template format." with the action "OK"


2.4. System functions per the Document-UT Compare requirement (H1016).

2.5. System displays the updated Document in the Content Editor.

3. Alt: AL DNE

In Response 5, if one or more selected Access Levels no longer exist, the System

removes them and displays: "The following Access Levels no longer exist and have been

removed. You can return to the Document or continue with the save." + a list of the



removed Access Levels , with the actions "Return to Document" (default) and

"Continue".

3.1. If the user selects "Return to Document":

3.1.1. System omits all remaining responses.


3.2. If the user selects "Continue", the System continues with Response 4.

Message Examples:

"The following Access Levels no longer exist and have been removed. You can return to

the Document or continue with the Save."

Access Level 1

Access Level 2

4. Alt: Properties Blank

In Response 6, if one or more required properties are not set:

4.1. System displays: "The following properties cannot be blank: <list of

properties>"; if a Content Area is blank the Area Name is used in the properties

list. with the option "OK"

Example: "The following properties cannot be blank: Title, Issue"



5. Alt: No Content

In Response 7, if the document contains no Information Component and no Content

Areas with text:

5.1. System displays: "The Document does not have any content. Are you sure you

want to continue with the save? " with the actions "Yes" and "No" (default)

5.2. If the User selects "Yes":

5.2.1. System closes the prompt.

5.2.2. System continues with the next response.

5.3. If the user selects "No":

5.3.1. System closes the prompt.

5.3.2. System omits all remaining responses.

6. Alt: Incorrect date Format

In Response 9, if the date format is incorrect:

6.1. System displays error indicating field and correct format; for example:

"Published: Date format is incorrect. Format must be mm/dd/yyyy" with the

action "OK"



7. Alt: Review Date < Today’s Date

In Response 10, if the Review Date is not later than today’s Date AND:

7.1. System displays: "Review Date must be later than today’s Date." with the action

"OK".





8. Alt: Archive Date < Today’s Date

In Response 11, if the Archive Date is not later than today’s Date AND:

8.1. System displays: "Archive Date must be later than today’s Date." with the action

"OK".



9. Alt: Supervisor Blank: In Response 14 if the Supervisor is blank, the System assigns a

Supervisor per the Assign Supervisor requirement (H1236).

Document Publish

H1050. Document Publish (Phase 2) shall function as follows:



and tested.

Document Submit

H1100. Doc Submit (Phase 1) shall function as follows:



and tested.

Save from Edit

H1099. Save from Edit shall function as follows:



and tested.

CONTENT MANAGER TAB

Functions

Change Supervisor

H1329. Change Supervisor shall function as follows:


(C1196)—to only display Active Users for selection.

Change Owner

H1331. Change Owner shall function as follows:

There are no changes to this requirement; however, it calls requirements with changes:

- C1082—to only send Email Notifications to Active users and that must be implemented

and tested.

C1196—to only display Active Users for selection.



CONTENT EDITOR

Functions

Save

H1293. Save shall function as follows:

There are no changes to this requirement; however, it calls H1141 and H1099, which call

H1103 (Document Properties check) so must be tested

Submit

H1228. Submit shall function as follows:

There are no changes to this requirement; however, it calls H1103 (Document Properties

check) so must be tested

Submit To

H1101. Submit To shall function as follows:

There are no changes to this requirement; however, it calls H1103 (Document Properties

check) so must be tested

Select Supervisor

H1252. Select Supervisor shall function as follows:



Select Owner

H1068. Select Owner shall function as follows:



Reject (back in workflow)

H1096. Reject (back in workflow) shall function as follows:



and tested.

Select Owner

H1068. Select Owner shall function as follows:



and tested.

Unassign Owner

H1259. Unassign Owner shall function as follows:



and tested.



I1-Envion, Install, OOB

UPGRADE

Database and Data

Permissions

I1134. Any permission not already installed shall be added.

Roles

I1132. The Admin Role shall be updated to include all permissions applicable to this release.

Users

I1133. All existing Users shall be Active after the upgrade.

I1135. All existing Users with Customer Roles shall have the Licensing property set to Concurrent.

J1-Performance

Performance should not be impacted by changes in this document. All existing requirements must be met.

K1-Analytics

COMMON

Filters

Filter: License Type

K1300. License Type Filter shall be a List Box that includes the License Types; the List Box shall be

configured as follows:

Title License Types

Contents License Types:

• Customer Concurrent

• Employee Concurrent

• Employee Named

Default: all are selected

Selection Type Multiple



REPORT TABS

License Analysis

This tab provides information on users who have accessed the system in each product and of each license

type.

K1143. License Analysis shall contain ALL sessions.

K1144. Dates: All charts shall contain all Sessions where the ending date is in the report's time

period.

K1145. The License Analysis Tab shall contain the following Filters:

Filter Presentation See (all under

Common, Objects)

Order Behavior

Date: Month

(Session Date)

List Box K1060 under Date

Filter: Month

c Displays data for sessions

that occurred in the

selected Months.

Date: Quarter

(Session Date)


Filter: Quarter

b Displays data for sessions


selected Quarters.

Date: Week

(Session Date)


Filter: Week

d Displays data for sessions


selected Weeks.

Date: Year

(Session Date)


Filter: Year

a Displays data for sessions


selected Years.

Interval List Box K1257 under Filter;

Interval (Not All)

n/a Alters line charts to display

the selected Interval on the

x-axis.

Data is divided by this

interval (e.g., days) based

on the session date and

time.

License Type List Box K1300 under Filter;

License Type

E

K1116. The License Analysis Tab shall contain the following in the Dashboard Area; in this order,

left to right, top to bottom:

1. Percent Named Used

2. Named users not logged in 6 months

3. Employee Concurrent Maximum

4. Customer Concurrent Maximum

5. License Trend



Tab Title

K1100. Sheet Title shall be "License Analysis".

Percent Named Used

K1150. Percent Named Used shall display the percentage of Named Licenses currently in use; this

number is always current and not based on date filters:

Chart Title % named

Chart Title Format Font Size: 16

Chart Type Gauge

Contents Percent of named licenses in use.

K1150.1. Percent used shall be calculated as follows:

Named Licenses Used / Named Licenses Available

Named Not Logged In

K1301. Named Not Logged In shall display the number of Named License users who have not

logged in in the last 3 months; this number is always current and not based on date filters:

Chart Title TBD


Chart Type Gauge

Contents Number of Named Users who have not logged in in 3

months.

K1301.1. Not Logged in shall be calculated as follows:

Today’s Date – Last Login Date > 3 months

Employee Concurrent Maximum

K1302. Employee Concurrent Maximum shall display the number maximum number of concurrent

users logged in at any time during the filter period:

Chart Title Empl Con Max


Chart Type Gauge

Contents Maximum number of Employee Concurrent licenses

used at any time.



Customer Concurrent Maximum

K1303. Customer Concurrent Maximum shall display the number maximum number of concurrent

users logged in at any time during the filter period:

Chart Title Cust Max


Chart Type Gauge

Contents Maximum number of Customer licenses used at any

time.

License Trend

K1171. The License Trend shall display trend of License use over time:

Chart Title License Trend

Chart Type Line

X-Axis 1. Interval

System shall show continuous interval values

Y-Axis 1. Employee Named Logins

2. Employee Concurrent Logins

3. Customer Concurrent Logins

Sort 1. Interval Date, Ascending

Contents All user logins during sessions in the filter date range.

K1171.1. Interval shall be configured as follows:

Label (none)

K1171.2. Employee Named Login shall be configured as follows:

Definition For each interval, the maximum number of Named

licenses in during that interval.

For example, the maximum number used at anytime

during a single day.

Label Employee Named

Number Type Integer

K1171.3. Employee Concurrent Login shall be configured as follows:



Definition For each interval, the maximum number of Employee

Concurrent users logged in during that interval.



Label Employee Concurrent

Number Type Integer

K1171.4. Customer Concurrent Login shall be configured as follows:

Definition For each interval, the maximum number of Customer

Concurrent users logged during that interval.



Label Customer Concurrent

Number Type Integer

QA Notes

There are some things that are NOT in requirements, because they are not changing. Some of these need

to be tested to ensure changes were not mistakenly implemented.

OBJECT USER PROPERTIES THAT DO NOT NEED TO BE ACTIVE

It is not required that the following be active users, so when objects are saved, there should be no error

regardless of if the user is active or inactive:

• All Objects: Creator, Last Modified By

• Things that are not affected by user being made inactive:

◊ Analytics

◊ All objects:

∗ Creator

∗ Last Modified By

∗ Users in:

− History

− Notes

◊ Group Members

Not removing inactive users from groups allows for a user to be re-activated and the admin not to

have to go back and add them to the Groups.

This does mean it is possible for a Group to be assigned to something and all its users to be

inactive so no one can perform the function. We are not going to check or code for that scenario.

We will, however, include a warning in the documentation about it.



TIMING ISSUES

There may be situations in which a user is set as an Owner or Supervisor and is inactive. I am not

accounting for every possible scenario that could occur (e.g., user selecting a new Owner and between

then and the Save the Owner User being made Inactive).

These scenarios really should not occur at a customer site. If they do, there should be no negative effect

on the system other than the Owner or Supervisor not getting a notification.

This is an extreme edge case but should be part of the Test Cases for this feature to ensure nothing really

bad happens.

Appendix A: Conventions

• GUI Terminology

The GWT Style Guide contains more details; however, definitions also apply to non-GWT technology.

◊ Inline Page (or Page): An inline page is one that is in the framework of the main application

window.

◊ Non-Modal Screen (or Screen): A non-modal screen is separate from the main application window

page, but is still part of the application and is not opened in a new full browser or browser tab.

◊ Modal Dialog (or Dialog): A modal dialog is displayed on top of the current screen or page.

• GUI Elements (Labels, Fields and Functions):

All GUI Elements are not always included and enabled. The individual requirements indicate when a

specific element is include and enabled.

◊ Included: An element that is included is present on the screen.

∗ "Always included" means it is always present.

∗ "Included only if…" indicates conditions under which it is included. GUI tables may have

separate columns where the column itself is the condition (e.g., if the screen has different

modes (read-only; edit; manage)).

If the condition is not true, the element is not present.

◊ Enabled: A field that is enabled is available for the user to type into or select from; a function that

is enabled is available for the user to select. Labels are always read-only.

∗ "Always enabled": means the element is always enabled.

∗ "Enabled only if…" indicates the conditions under which the element is enabled. GUI tables may

have separate columns where the column itself is the condition (e.g., if the screen has different

modes (read-only; edit; manage)).

If a field or function is enabled only under certain conditions, it is disabled if those conditions

are not true.

∗ "Read-only": Used for fields that are present but always read-only (e.g., a screen label, create

date). In some cases, the values can be changed, but through a function, which is listed

separately with its own enabled/disabled conditions.

◊ In some cases, a field may be "blank"; this refers to the field value, not the field label. It is used in

cases where we want to include the label, but indicate that no value is assigned (for example, in

product, a Document ID is not assigned until the document is saved, but we do not want to hide

the Document ID field itself—that is considered bad design for localization).

◊ How functions are implemented (buttons, links, menus) is part of GUI design and based on internal

and industry standards.



◊ Fields types (single-line text boxes, multi-line text boxes, radio buttons, DDL) are included in the

requirements.

• Formatting

◊ Angle brackets ( < > ) are used to indicate variables. The brackets and words inside the brackets

should be replaced with the appropriate variable value at runtime. For example:

Message: <property> cannot contain spaces

Example: Password cannot contain spaces.

◊ Italics: References to other documents and sections (or headings) are in italics.

◊ Strikeout: Struck out requirements or parts of requirements have been removed; the strikeout is

used to explicitly show that something that was implemented at one time needs to be removed.

Strikeout is used only for features and functionality that was implemented in a previous release or

sprint. It is not used during document reviews before implementation (track changes is used for

that purpose to indicate changes from one review version to another).

◊ Underline is used for:

∗ Requirement labels so they stand out in the text of the requirement.

∗ References to a specific requirement that include the label. For example: Functions per the

General Save requirement (C1000) in the C1-Shared PRD.

◊ Grey text enclosed in {} are notes for the document owner about similar requirements so when

changes are made they are made consistently.

• Highlighting

◊ The following highlight colors are used to indicate different types of requirements:

Color Purpose Reviewer Responsibility

Yellow New functionality for the release. Review and plan release based on these

requirements.

Light Blue Newly included or updated

requirements for existing

functionality.

Review and indicates any disagreement

about how functionality is described in

requirements vs. how you think it does or

should work.

No highlight Existing requirements; previously

included and reviewed.

None

◊ In addition, the following highlight colors may be used to indicate open questions or action items.

Color Purpose Reviewer Responsibility

Green Questions for reviewers to answer Answer!

Purple Author’s questions/to do list; goal is to NOT have

any of these when a document is posted for

review.

None

Grey Author’s notes for future changes, things to do

later (like enter bugs).

None

