Information & Technology Services
Rochester Institute of Technology
Information & Technology Services
RIT RSS News Feed Generator
Requirements Document – Use Cases
Proprietary Information
This document contains proprietary information and is not for use outside Rochester Institute of Technology. Information within this document is subject to change without notice.
Related Documents
Document ID / Document Title / Author(s) / Revision / Effective DateTo be assigned by PMO / RSS News Feed Generator Requirements – Use Cases
Document Change Control
Revision / Date / Author / Section / Content Changes or Additionsv.1 / 12/3/02 / Kristi Davis / All / Basic outline to be used by project team.
v.2 / 1/23/02 / Carol Coon / All / Added the use cases
Content Owner
Name / Department / Phone Number / Alternate ContactKristi Davis / ITS / 475-2800
/ Jeremy Trumble ()
Table of Contents
1.1 Description
1.2 Users
1.2.1 Approved Use Cases
1.2.2 Use Cases Pending Departmental Approval
1.3 Administrators
1.3.1 Approved Use Cases
2. Approval
Table of Figures
Figure 1 Use Case Interaction Diagram
Table 1 Use Case 1 - Login to Tool
Table 2 Use Case 2 - Logout
Table 3 Use Case 3 - Create News Item
Table 4 Use Case 4 - Upload News
Table 5 Use Case 5 - Link Previously Written News
Table 6 Use Case 6 - Remove News from Department RSS News Feed
Table 7 Use Cases 7 - Delete News from Server
Table 8 Use Case 8 - Update News Link Only
Table 9 Use Case 9 - Update News Content Only
Table 10 Use Case 10 - Move News Item
Table 11 Use Case 11 - Add Content Owner
Table 12 Use Case 12 - Delete Content Owner
Table 13 Use Case 13 - Create a News Feed
Table 14 Use Case 14 - Delete News Feed
Table 15 Use Case 15 - Change News Feed Location
Table 16 Use Case 16 - Change Feed Details
Table 17 Use Case 17 - Purge News From News Feed
1. Use Cases
1.1 Description
A use case is like a scenario. Each use case represents an action that a user can perform. Each use case has a priority assigned to it. Cases with high priority will be implemented first in the system. Cases with low priority will be implemented last. Each use case has a summary, giving a high level description of the use case. The primary scenario is the steps that will be followed the most often, and if there are no errors. The alternate path is the steps that can occur if the user chooses the alternative path to one or more of the steps in the primary scenario. The Exception path is what will occur if an error is introduced to the system. The pre-conditions of the use case are the state the system must be in before the case may be entered. The post-conditions of the use case are the state the system must be in when the use case is successfully exited.
The following Use Case Interaction Diagram describes how each use case interacts with the external actors to the system (users, other programs, etc.) and with other use cases. For example, the “Create News Feed” use case interacts with the department administrator, as the department administrator is the only one who can create a news feed. The case also interacts with the web server, as this is where the feed will be stored. Finally, the case interacts with the “Login” use case, as the department administrator must be logged into the system in order to create a feed.
Figure 1Use Case Interaction Diagram
1.2 Users
1.2.1 Approved Use Cases
Table 1 Use Case 1 - Login to Tool
Identification: UC1Use Case Name: Login to tool
Priority: High
Summary: This is the use case, which will allow users to begin using the program.
Primary Scenario:
1. User views login screen
2. System requests user identification and authentication.
3. User provides id and authentication information.
4. System authenticates user.
5. Authentication is OK. System presents user with main screen
Alternate Paths: Administrative login brings up administrative mode.
Exception Paths:
4a. Authentication failure.
4b. System returns to step 1.
Pre-Conditions: No user is logged in.
Post-Conditions: User is logged into system and has access to appropriate options, depending on type of account (user or super user)
Author(s): P. Light
Date:
1/13/03, updated 1/30/03
Table 2 Use Case 2 - Logout
Identification: UC2Use Case Name: Logout
Priority: High
Summary: This is the use case, which will allow users to cease using the program.
Primary Scenario:
1. User selects logout from main menu.
2. System logs the user off.
Alternate Paths: none
Exception Paths: none
Pre-Conditions: UC 1
Post-Conditions: User is no longer able to perform any operations without logging in again.
Author(s): P. Light
Date:
1/13/03, updated 1/30/03
Table 3 Use Case 3 - Create News Item
Identification: UC3Use Case Name: Create News Item.
Priority: High
Summary: A content owner can create an html-based news item and add the news link to the department’s RSS news feed.
Primary Scenario:
- Content owner selects to create a news item.
- System enters news creation mode.
- Content owner enters news item information and expiration date.
- Content owner selects template.
- System previews news item for content owner.
- User approves preview.
- System saves news item.
- System prompts content owner to add news item to the department’s news feed.
- Content owner chooses to add news item to department’s news feed.
- System adds news item to department’s news feed.
- System exits news creation mode.
Alternate Paths:
7a. Content owner chooses to edit news item
9a. Content owner chooses not to add news item to the department’s news feed
Exception Paths:
7a. System indicates error in save
7b. User acknowledges error.
7c. System returns to step 7.
Pre-Conditions: UC 1
Post-Conditions:
News has been saved.
Author(s): Rebecca Vanderhoff
Date: 1/31/03
Table 4 Use Case 4 - Upload News
Identification: UC4Use Case Name: Upload News
Priority: High
Summary: Add previously written news item to the system and upload the news item onto the system.
Primary Scenario:
- User selects to upload news.
- System enters upload news mode.
- The user types in the location of the news item
- The system checks that the news item exists
- The system saves the news item on the server
- The system updates the RSS
- The system displays a message box telling the user that the action was completed successfully
- The system returns the user to the main menu
Alternate Paths:
5a. The news item does not exist.
5b. System returns to step 3.
Exception Paths:
6a. System indicates error during save.
6b. User acknowledges error.
6c. System returns to step 5.
Pre-Conditions: Use Case 1
Post-Conditions:
- The news item has been saved on the server
- RSS has a link for the news item
- The system is ready to accept next user operation.
Author(s): Carol Coon
Date: 1/12/03, updated 1/30/03
Table 5 Use Case 5 - Link Previously Written News
Identification: UC5Use Case Name: Link Previously Written News Item
Priority: High
Summary: A content owner can add a news link to the department’s RSS news feed.
Primary Scenario:
- Content owner selects to add a news link to the department’s news feed
- System prompts content owner for news link
- Content owner specifies news link
- System adds news link to department’s news feed
Alternate Paths: none
Exception Paths: none
Pre-Conditions: Content owner is logged into the system
Post-Conditions: News link has been added to the department’s news feed
Author(s): Rebecca Vanderhoff
Date: 1/31/03
Table 6 Use Case 6 - Remove News from Department RSS News Feed
Identification: UC6Use Case Name: Remove news item from departments RSS news feed
Priority: Medium
Summary: A content owner can remove a news link from the department’s news feed.
Primary Scenario:
- Content owner selects to remove a news link
- System displays the news items in the department’s news feed
- Content owner selects the news item to remove
- System removes the news link from department’s news feed
Alternate Paths:
1a. System removes news link after the expiration date on the news item has passed
Exception Paths: none
Pre-Conditions: Content owner is logged into the system
Post-Conditions: News \ link has been removed from the department’s news feed
Author(s): Rebecca Vanderhoff
Date: 1/31/03
Table 7 Use Cases 7 - Delete News from Server
Identification: UC7Use Case Name: Delete news item from server
Priority: High
Summary: The user will have the system delete the news item from the server, not just remove the link.
Primary Scenario:
- The user indicates the “Remove News Item” option
- The system enters the “Remove News Item” mode
- The user selects “Delete News Item and Corresponding Link”
- The system indicates the list of news items the user has access to
- The user indicates the news item to be deleted
- The system removes the link for the selected news item
- The system deletes the news item from the system
- The system indicates that the action was completed successfully
- The system returns to operation selection mode
Alternate Paths: none
Exception Paths: none
Pre-Conditions: System is in operation selection mode
Post-Conditions:
- The system is in operation selection mode
- The news item no longer exists
- There is no link to the deleted news item
Author(s): Carol Coon
Date: 1/12/03, updated 1/30/03
1.2.2 Use Cases Pending Departmental Approval
Table 8 Use Case 8 - Update News Link Only
Identification: UC8Use Case Name: Update news link only
Priority: Pending
Summary: A content owner updates the link to a news item
Primary Scenario:
- User selects update news item from the main menu
- System enters update news item mode
- User enters keyword and sorting criteria
- System indicates the news items in a list
- User selects the appropriate news item from the list
- User selects “update news item link only” option
- System requests the new URL of the news page
- User indicates the new URL
- System verifies the new URL
- System updates the RSS feed with new URL
Alternate Paths:
4a. User chooses date range search
4b. User enters the date range
4c. Steps from 8 continues from primary scenario
Exception Paths:
6a. System indicates that no results matched the search criteria
6b. User corrects the search criteria and continues from step 5
13a. System indicates an error that file doesn’t exist in the given URL
13b. User acknowledges the error
13c. System returns to step 9
Pre-Conditions: The user is at the main page
Post-Conditions: The RSS news feed gets updated with the new link for the corresponding item
Author(s): Madura Mahenthiran
Date: 01/11/03
Table 9 Use Case 9 - Update News Content Only
Identification: UC9Use Case Name: Update news content only
Priority: Pending
Summary: A content owner updates the contents of news that already exist in news feed
Primary Scenario:
- User selects update news item from the main menu
- System displays the update news item page
- User chooses keyword search
- User enters the keyword
- User enters the sorting criteria
- System displays the news items in a list
- User selects the appropriate news item from the list
- User requests to update news content
- System loads the news item in edit mode
- User changes the content
- User Submits the content
- User selects the template
- User chooses to preview
- System loads the news in the selected template
- User previews
- User posts news
- System loads the main page
Alternate Paths:
4a. User chooses date range search
4b. User enters the date range
4c. Steps from 8 continues from primary scenario
Exception Paths:
6a. System says that no results matched the search criteria
6b. User corrects the search criteria and continues from step 5
Pre-Conditions: System is in operation selection mode
Post-Conditions: The HTML page gets updated in the web server
Author(s): Madura Mahenthiran
Date: 01/11/03
Table 10 Use Case 10 - Move News Item
Identification: UC10Use Case Name: Move news item
Priority: Pending
Summary: A content owner member moves the news item from one location to another
Primary Scenario:
- User selects update news item from the main menu
- System displays the update news page
- User chooses keyword search
- User enters the keyword
- User enters the sorting criteria
- System displays the news items in a list
- User selects the appropriate news item from the list
- User checks move news item option
- System requests the new URL of the news page
- User provides the new URL
- System verifies the new URL
- System transfers the file from original location to new location
- System updates the RSS feed with new URL
- System returns to main menu
Alternate Paths:
4a. User chooses date range search
4b. User enters the date range
4c. Steps from 8 continues from primary scenario
Exception Paths:
6a. System says that no results matched the search criteria
6b. User corrects the search criteria and continues from step 5
13a. System displays the error that file doesn’t exist in the given URL
13b. User acknowledges error
13c. Return to step 9
Pre-Conditions: System is in main menu mode
Post-Conditions:
- The file gets transferred to new location
- The RSS news feed gets updated with the new link for the corresponding item
- System is in main menu mode
Author(s): Madura Mahenthiran
Date: 01/11/03
1.3 Administrators
1.3.1 Approved Use Cases
Table 11 Use Case 11 - Add Content Owner
Identification: UC11Use Case Name: Add content owner
Priority: High
Summary: Department administrator adds content owners who will be authorized to use RNG tool
Primary Scenario:
- Administrator requests “manage users” option from administrator main menu
- System enters manage users mode.
- Administrator provides new user information.
- System confirms that user has been to added to content owner list
- System returns to administrator main menu
Alternate Paths:
None
Exception Paths:
4a. System finds required fields are incomplete or invalid or user information is already in system.
4b. System asks user to correct invalid fields.
4c. System returns to step 3.
Pre-Conditions: System is in administrator operation selection mode
Post-Conditions: The content owner user groups table shall have new user added.
Author(s): Madura Mahenthiran
Date: 1/19/03
Table 12 Use Case 12 - Delete Content Owner
Identification: UC12Use Case Name: Delete content owner
Priority: High
Summary: Department administrator shall delete content owners from the database
Primary Scenario:
- Administrator selects manage users from administrator’s main menu
- System presents an add /delete users page
- Administrator selects username of the user to be removed
- Administrator selects delete user
- System confirms that user has been deleted from content owner list
Alternate Paths: none
Exception Paths: none
Pre-Conditions: The user shall be in the content owner list initially
Post-Conditions: The user shall be removed from content owner list table in the database
Author(s): Madura Mahenthiran
Date: 1/19/03
Table 13 Use Case 13 - Create a News Feed
Identification: UC13Use Case Name: Create news feed
Priority: High
Summary: Department administrator would like to add a news feed to Prometheus.
Primary Scenario:
- Administrator logs in at authentication screen.
- Administrator selects “External Feeds” in main menu.
- Administrator enters “feed name”.
- Administrator enters “feed URL”.
- Administrator selects “Add Feed”.
Alternate Paths:
NONE
Exception Paths:
1a. Administrator login invalid.
3a. System rejects feed name as invalid.
3b. System prompts for re-entry of data.
4a. System rejects feed URL as invalid.
4b. System prompts for re-entry of data.
5a. System rejects addition of news feed.
Pre-Conditions: News feed must not already exist.
Post-Conditions: The news feed is now added to the Prometheus’ record of news feeds.
Author(s): Chris Mamorella
Date: 1/12/03
Table 14 Use Case 14 - Delete News Feed
Identification: UC14Use Case Name: Delete news feed.
Priority: Low
Summary: Department Administrator would like to delete a news feed from Prometheus.
Primary Scenario:
- Administrator logs in at authentication screen.
- Administrator selects “External Feeds” in main menu.
- Administrator selects feed from “Edit/Delete feeds” drop-down list.
- Administrator selects “Delete Feed”.
Alternate Paths:
none
Exception Paths:
1a. Administrator login invalid.
4a. System rejects delete action.
Pre-Conditions: News feed already exists.
Post-Conditions: The news feed is now deleted from Prometheus’ record of news feeds.
Author(s): Chris Mamorella
Date: 1/12/03
Table 15 Use Case 15 - Change News Feed Location
Identification: UC15Use Case Name: Change News Feed Location.
Priority: Medium
Summary: Department Administrator would like to change URL of a news feed.
Primary Scenario:
1. Administrator logs in at authentication screen.
- Administrator selects “External Feeds” in main menu.
- Administrator selects feed from “Edit/Delete feeds” drop-down list.
- Administrator changes the “Feed URL”.
- Administrator selects “Edit Feed”.
Alternate Paths:
none
Exception Paths:
1a. Administrator login invalid.
5a. System rejects new URI.
Pre-Conditions: News feed already exists.
Post-Conditions: Prometheus recognizes the new URL for the news feed.
Author(s): Chris Mamorella
Date: 1/12/03
Table 16 Use Case 16 - Change Feed Details