Skip to content

Latest commit

 

History

History
1603 lines (1568 loc) · 45 KB

UseCases.md

File metadata and controls

1603 lines (1568 loc) · 45 KB

Use Case Descriptions

Table of Contents

  1. Diagrams
  2. Member / Visitors Use Case Descriptions
  3. Sign up for account
  4. Login to site
  5. Setup Profile
  6. Opt In/Out of receiving promotional materials by email
  7. Set Platform Preference
  8. Set game category preference
  9. Member registers a credit card
  10. Add or Modify a shipping address
  11. Delete a shipping address
  12. Reset member password
  13. Search for event
  14. View game reviews
  15. Review games
  16. Rate games
  17. Add friends and family to account
  18. View another members wishlist
  19. Add to Wishlist
  20. Member Downloads Game
  21. Member Checkout
  22. Add game to cart
  23. Display game details
  24. Search for games
  25. Employee Use Case Descriptions
  26. Add Event
  27. Edit Event
  28. Delete Event
  29. Add Game
  30. Edit Game
  31. Delete Game
  32. Ship Games
  33. Approve Reviews
  34. View Report

Diagrams

Members and Visitors Diagram Employees Diagram

Members / Visitors

Sign up for account

Use Case Name Sign Up For Account
Description The visitor will sign up for a new account on the CVGS site
Actor(s) Visitor
Preconditions 1. Visitor goes to the CVGS site.
Basic Flow of Events Actor System
1 Visitor clicks “Sign Up for new Account”
3 User fills out form and clicks submit
2 System displays a form for the user to fill out including username, and unique password.
4 System creates an entry for the user in the database and returns a message: “Account created”.
Alternate Flow(s) 2.1 Site is redirected to the initial sign-up page.
Success Guarantee Visitor's account is created
Minimum Guarantee Visitor can try to create the account again.

Login to site

Use Case Name Login to site
Description User enters a valid username and password
Actor(s) Member, Employee
Preconditions User must have created an account
Basic Flow of Events Actor System

1. User enters a username and password

2. System returns display of main site page

Alternate Flow(s) 2.1 System returns to the login page
Success Guarantee User will be logged into their account on their home screen.
Minimum Guarantee User will be re-prompted for username and password.

Setup Profile

Use Case Name Setup/Update Profile
Description Member can setup or update their profile for their account
Actor(s) Member
Preconditions Account must be active and user must be logged in.
Basic Flow of Events Actor System
1. User selects “Profile”
3. User enters in data and clicks submit.
2. System redirects user to “Member Profile” page where they can fill in their display name, actual name, email, gender, and birthdate.
4. System updates database and returns message: “Profile updated successfully”.
Alternate Flow(s) 2.1 No profile page is found, user is redirected to their account default page.
4.1 System is unable to update the database, returns message “Profile not updated”
Success Guarantee User is able to enter their info and it is saved in their profile.
Minimum Guarantee User can try to update their profile again.

Opt In/Out of receiving promotional materials by email

Use Case Name Opt In/Out of receiving promotional materials by email
Description Member decides whether to receive promotional material via email.
Actor(s) Member
Preconditions User must be logged in
Basic Flow of Events Actor System
1. User selects “Profile”
3. User checks/unchecks opt in check box and clicks submit
2. System redirects user to “Member Profile” page, which has an opt-in checkbox
4. System returns a confirmation of setting change and updates database
Alternate Flow(s) 4.1 State of promotional materials not changed, message that the state of promotional materials is unchanged.
Success Guarantee State of promotional materials changes, message states: “promotional materials will (not) be sent out.
Minimum Guarantee User can try again to change the state of receiving promotional material.

Set Platform Preference

Use Case Name Set Platform Preference
Description Allows the user to specify their preferred gaming platform.
Actor(s) Member
Preconditions User has logged into their account, and is updating their account preferences.
Basic Flow of Events Actor System
1. User selects “Profile”
3. User selects their preferred platform from a list (ie desktop PC, tablet, or mobile phone) and clicks submit
2. System redirects user to “Member Profile” page, which has a platform preference listbox
4. System stores the selected platform and returns a success message to the user.
Alternate Flow(s) 4.1 System does not store preferred platform, message to user “preferred platform not saved”
Success Guarantee System messages user: “preferred platform saved”
Minimum Guarantee User will get a successful or not successful message returned.

Set game category preference

Use Case Name Set game category preference
Description User sets their preferred game category
Actor(s) Member
Preconditions User is logged in to their account.
Basic Flow of Events Actor System
1.User clicks “Profile”
3.User selects their preferred game category from the list and then clicks Submit
2. User is taken to the “Member Profile” page
4. System stores the selected category and returns a success message to the user
5. Return the user to the Home screen
Alternate Flow(s) 2.1 User remains on the “Home” screen
Success Guarantee The preferred game category is updated for the user.
Minimum Guarantee The user is returned to the Home screen to try to update the preferred game category again.

Member registers a credit card

Use Case Name Member registers a credit card
Description User adds a credit card to their account
Actor(s) Member
Preconditions User is logged in to their CVGS account
Basic Flow of Events Actor System
1. User clicks on “Profile” from main page.
3. User selects “Add Credit Card”
5. User enters credit card data and clicks “Submit”
7. User clicks “Confirm”
2.System returns the “Member Profile” page
4. System returns the page form for adding a credit card.
6. System validates details and returns confirmation message
8. System adds credit card to database and returns user to the “Member Profile” page where they may add other cards.
Alternate Flow(s) 5.1 User enters invalid data
6.1 System returns the credit card page with errors highlighted
Success Guarantee Card is added to the users profile
Minimum Guarantee User can try to add the credit card again.

Add or Modify a shipping address

Use Case Name Add or Modify a shipping address
Description User adds or modifies a shipping address connected to their profile
Actor(s) Member
Preconditions User is logged in to a valid account
Basic Flow of Events Actor System
1. User clicks on “Profile” from main page.
3. User selects “Shipping Options”
5. User clicks “Add or Update Shipping Address”
7. User enters details and clicks Submit
9. User clicks “Confirm”
2. System returns the “Member Profile” page
4. System returns the “Shipping details” page
6. System returns address entry form page
8. System validates information entered. Returns confirmation to user
10. System updates the information in the database and returns an email to the user notifying them of the change
Alternate Flow(s) 8.1 System returns the address entry form with errors highlighted
Success Guarantee User address is added to the users profile
Minimum Guarantee User has the option of adding address to profile again.

Delete a shipping address

Use Case Name Delete a shipping address
Description User deletes a shipping address connected to their profile
Actor(s) Member
Preconditions User is logged in to their CVGS account
Basic Flow of Events Actor System
1. User clicks on “Profile” from main page.
3. User selects “Shipping Options”
5. User clicks “Delete Shipping Address”
7. Users confirms message box.
2. System returns the “Member Profile” page
4. System returns the “Shipping details” page
6. System returns a confirmation message
8. System updates database and returns email to user confirming the change
Alternate Flow(s) 7.1 User clicks “Cancel”
8.1 System returns the “Profile” page. No changes are committed to the database
Success Guarantee User deletes shipping address linked to profile
Minimum Guarantee User can again try to delete the shipping address from profile

Reset member password

Use Case Name Reset member password
Description User resets their password
Actor(s) User
Preconditions None
Basic Flow of Events Actor System
1. User forgets their password. Clicks “Forgot Password” and enters their account username
3. User receives email saying a password reset has been requested for the account, User clicks link within
5. User is asked to enter a new password. User submits the form.
2. Systems returns Email to the registered username of the account.
4. System returns a password reset page.
6. System commits changes to user account. Returns user to login page.
Alternate Flow(s) 2.1 System does not return an email
4.1 System does not return a password reset page
6.1 System does not commit changes, password is not reset.
Success Guarantee User password linked to profile is reset
Minimum Guarantee User can try to reset their password again.

Search For Event

Use Case Name Search For Event (optional registration)
Description User registers for an event through the website.
Actor(s) Member
Preconditions User is logged in to their CVGS account, user is a member
Basic Flow of Events Actor System
1. User finds an event they are interested in and clicks it.
3. User reads through detail and decides to participate in event. Clicks “Join”
5. User confirms the message.
2. System returns a page of details about selected event.
4. System returns a confirmation message to the user
6. System adds user to a list of attendees for event and returns a message to the user that they have been registered
Alternate Flow(s) 3.1 User decides they are not interested. Clicks “Return to Events”
4.1 System returns Events list
Success Guarantee User is able to register for events listed on site
Minimum Guarantee User can retry to register for events.

View game reviews

Use Case Name View game reviews
Description Member/Visitor views game reviews on website.
Actor(s) Member, Visitor
Preconditions User is on the CVGS website. Browsing games.
Basic Flow of Events Actor System
1. On finding a game user clicks the game. 2. System returns a details page for the game which contains reviews.
Alternate Flow(s)
Success Guarantee User/Visitor browse reviews of game.
Minimum Guarantee User can try again browse reviews.

Review games

Use Case Name Review games
Description User reviews a game on website.
Actor(s) Member
Preconditions User is logged in to their CVGS account and viewing available games.
Basic Flow of Events Actor System
1. On a particular game user clicks “Review game”
3. User enters their review and clicks submit.
2. System returns a form to review game.
4. System adds review to list of reviews for the game along with the username of the user who wrote the review.
Alternate Flow(s) 2.1 System doesn't return a form for review
4.1 System doesn't add review, returns an error message to user and redirects them to their account Home page.
Success Guarantee User's review is submitted.
Minimum Guarantee User can try again to review a game.

Rate games

Use Case Name Rate games
Description User rates a game on website.
Actor(s) Member
Preconditions User is logged in to their CVGS account and is on a particular game”s page.
Basic Flow of Events Actor System
1. On a particular game user clicks available star rating shown with game 2. System adds star rating to posted review
Alternate Flow(s) 2.1 System does not add star rating to the game.
Success Guarantee User is able to rate the game.
Minimum Guarantee User has the option to try to rate the games again.

Add friends and family to account

Use Case Name Add friends and family to account
Description User connects friends and family to account
Actor(s) Member
Preconditions User is logged in to their CVGS account and is on their approved contacts page
Basic Flow of Events Actor System
1. User selects “Search for contacts” and enters in contact name.
3. User selects contact from list and clicks “Add Friend”
2. System searches for contact and returns a list matching search criteria.
4. System adds contact to User's Friends/Family list, sends message “contact added” back to User
Alternate Flow(s) 2.1 System doesn't find any matches, returns an empty list and a message indicating no contacts found.
4.1 System is unable to add contact, returns message: “Unable to add contact”
Success Guarantee Contact is added to User's Friends/Family contact list.
Minimum Guarantee User can try to add the contact again.

View another members wishlist

Use Case Name View another members wishlist
Description User views another users wishlist
Actor(s) Member
Preconditions User is logged in to their CVGS account
Basic Flow of Events Actor System
1. User clicks on their contact page
3. User selects a contact and clicks on it.
5. User clicks “View Wishlist”
2. System returns list of contacts
4. System returns a view of the chosen contact
6. System returns the wishlist of the contact to the User
Alternate Flow(s) 2.1 No list of contacts is returned
4.1 Chosen contact info not returned
6.1 No wish list is returned
Success Guarantee User is able to view the chosen contact”s wishlist
Minimum Guarantee User can try again to view another contact”s wish list.

Add to Wishlist

Use Case Name Add to Wishlist
Description User adds an item to their wishlist
Actor(s) Member
Preconditions User is logged in to their CVGS account and is viewing a game.
Basic Flow of Events Actor System
1. User selects “Add to wish list” for game they are viewing. 2. System adds item to users wish list and saves in the database. Returns message “Game added to wish list”.
Alternate Flow(s) 2.1 Systems doesn't add game to User's wish list, returns message “Game not added to wish list”
Success Guarantee User adds game to their wish list
Minimum Guarantee User can try again, to add the game to their wish list.

Member Downloads Game

Use Case Name User Downloads Game
Description User downloads a game
Actor(s) Member
Preconditions User is logged in to their CVGS account
Basic Flow of Events Actor System
1. User browses free games. User finds a game that interests them and selects it.
3. User has option to download game. User clicks “Download”
5. User is able to install and play game
2. System returns a page of details about game.
4. System returns a download of the game.
Alternate Flow(s) 2.1 System does not return a page of game details
4.1 System does not download the selected game.
Success Guarantee User is able to download the selected game.
Minimum Guarantee User can try again, to download the game.

Member Checkout

Use Case Name User Checkout
Description User checks out cart
Actor(s) Member
Preconditions User is logged in to their CVGS account.
Basic Flow of Events Actor System
1. User clicks checkout from the main store page.
3. User reviews order and clicks checkout.
5. User clicks “Ok” if satisfied with the details
2. System returns a cart page with details of purchases.
4. System returns a view to review shipping detail and credit card information
6. System adds information to db for shipping and returns an order confirmation number.
Alternate Flow(s) 2.1 System doesn't return a cart page
4.1 System doesn't return a shipping detail view
6.1 System doesn't confirm shipment or accept payments.
Success Guarantee User is able to checkout cart items from the store for purchase.
Minimum Guarantee User can try to process their shopping cart again.

Add game to cart

Use Case Name Add game to cart
Description User adds a game to cart
Actor(s) Member
Preconditions User is logged in to their CVGS account and be browsing the store.
Basic Flow of Events Actor System
1. User browses games and finds a game that interests them and selects it.
3. User purchases game by clicking “Purchase”
2. System returns a page of details about game.
4. System returns a message that game has been added to cart. User is redirected to browsing page.
Alternate Flow(s) 2.1 System does not return a details page for the game.
4.1 System does not add the game to the cart, message “Game not added to cart”
Success Guarantee User is able add game to store cart
Minimum Guarantee User may try again to add the game to the cart.

Display game details

Use Case Name Display game details
Description Visitor/Member views the details of a game
Actor(s) Visitor, Member
Preconditions Visitor/Member is on the CVGS websites.
Basic Flow of Events Actor System
1. User selects a game from the list. 2. System returns a page displaying the details for the game.
Alternate Flow(s) 2.1 System does not return game details
Success Guarantee Visitor/User is able to view game details.
Minimum Guarantee Visitor/User can try again to view the game details.

Search for games

Use Case Name Search for games
Description Visitor/Member searches for a game
Actor(s) Member, Visitor
Preconditions User is on the CVGS website.
Basic Flow of Events Actor System
1. Visitor/User enters a search term or keyword into the sites search bar 2. System returns a list of available games that match that query
Alternate Flow(s) 2.1 System does not return a list of games.
Success Guarantee Visitor/User finds game via search
Minimum Guarantee Visitor/User can try to search again.

Employees

Add Event

Use Case Name Add Event
Description The employee adds an event to the web site.
Actor(s) Employee
Preconditions Employee is logged in to the CVGS web site, on the Events page.
Basic Flow of Events Actor System
1. Employee clicks “Add Event” link
3. Employee clicks “Submit data”
2. System returns a form for the employee to fill out including: event name, description, date and time
4. System updates database with the new event and returns a message “Successfully Added Event” to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 1.1 System doesn't return an event form for the user to fill out.
4.1 System does not update the database, message returned to user is: “Event not Added”
Success Guarantee Event is Added
Minimum Guarantee Employee will be able to try to add the event again

Edit Event

Use Case Name Edit Event
Description Employee edits an event on the web site.
Actor(s) Employee
Preconditions Employee is logged in to the CVGS web site.
Basic Flow of Events Actor System
1. Employee clicks “Event” link
3. Employee selects an event to edit from the list and clicks “Edit” on that event
5. Employee updates the event and clicks “Submit data”
2. System returns a list of events.
4. System returns the selected event in an editable form.
6. System updates database with the new event and returns a message “Successfully Updated Event” to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a list of events
4.1 System doesn't return the selected event.
6.1 System does not update the database, message returned to user is: “Event not Updated”
Success Guarantee Event is Updated
Minimum Guarantee Employee will be able to try to update the event again

Delete Event

Use Case Name Delete Event
Description The employee deletes an event from the web site.
Actor(s) Employee
Preconditions Employee is logged in to the CVGS web site.
Basic Flow of Events Actor System
1. Employee clicks “Event” link
3. Employee selects an event to delete from the list and clicks “Delete” on that event
5. Employee selects YES
2. System returns a list of events.
4. System returns “Are you sure you wish to delete this event?”
6. System deletes the event and updates the database and returns a message “Successfully Deleted Event” to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a list of events
4.1 System doesn't delete the selected event.
6.1 System does not update the database, message returned to user is: “Event not Deleted”
Success Guarantee Event is Deleted
Minimum Guarantee Employee will be able to try to delete the event again

Add Game

Use Case Name Add Game
Description The employee adds a game to the web site.
Actor(s) Employee
Preconditions Employee is logged in to the CVGS web site and is viewing the Games page.
Basic Flow of Events Actor System
1. Employee clicks “Add Game” button
3. Employee fills out form and clicks “Submit data”
2. System returns a form for the employee to fill out including: game name, description, category
4. System updates database with the new game and returns a message “Successfully Added Game” to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a game form for the user to fill out.
4.1 System does not update the database, message returned to user is: “Game not Added”
Success Guarantee Game is Added
Minimum Guarantee Employee will be able to try to add the game again

Edit Game

Use Case Name Edit Game
Description The employee edits a game on the web site.
Actor(s) Employee
Preconditions Employee is logged in to the CVGS web site.
Basic Flow of Events Actor System
1. Employee clicks “Games” link
3. Employee selects a game to edit from the list and clicks “Edit” on that game
5. Employee updates the game via the form and clicks “Submit”
2. System returns a list of games.
4. System returns a page with the selected game and a form to edit the fields.
6. System updates database with the new game and returns a message “Successfully Updated Game to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a list of games
4.1 System doesn't return the selected game.
6.1 System does not update the database, message returned to user is: “Game not Updated”
Success Guarantee Game is Updated
Minimum Guarantee Employee will be able to try to update the game again

Delete Game

Use Case Name Delete Game
Description The employee delete a game from the web site.
Actor(s) Employee
Preconditions Employee is logged in to the CVGS web site.
Basic Flow of Events Actor System
1. Employee clicks “Games” link
3. Employee selects a game to delete from the list and clicks “Delete” on that game
5. Employee selects YES
2. System returns a list of games.
4. System returns “Are you sure you wish to delete this game?”
6. System deletes the game and updates the database and returns a message “Successfully Deleted Game to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a list of games
4.1 System doesn't display dialogue to user.
6.1 System does not update the database, message returned to user is: “Game not Deleted”
Success Guarantee Game is Deleted
Minimum Guarantee Employee will be able to try to delete the game again

Ship Games/Mark Order Processed

Use Case Name Ship Games/Mark Order Processed
Description An employee ships a game to a member and marks the order as processed.
Actor(s) Employee
Preconditions 1. Employee is logged in to the CVGS web site.
2. Order exists and all items are available.
Basic Flow of Events Actor System
1. Employee clicks “Orders button”
3. Employee selects an unshipped order to process
5. Employee packages and ships all items and marks the order as 'processed'
2. System returns a list of shipped and unshipped orders.
4. System returns a view of the order
6. System processes the order and returns a message “Successfully Processed Order” to the website. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a list of orders
4.1 System doesn't return a view of the order
6.1 System does not process the order and returns a mess “Unable to Process Order”
Success Guarantee Games are shipped to the member
Minimum Guarantee Employee will be able to try to mark the order as processed again

Approve Reviews

Use Case Name Approve Reviews
Description The employee approves a review posted by a member.
Actor(s) Employee
Preconditions Employee is logged in to the employee portal of the CVGS website.
Basic Flow of Events Actor System
1. Employee clicks “View unapproved reviews”
3. Employee selects a review to view and if acceptable click approved
2. System returns a list of unapproved reviews
4. System updates database to indicate that the selected review has been approved. As well, system returns a message “Successfully approved review” to the user. The system then returns the Employee to their Home Screen
Alternate Flow(s) 2.1 System doesn't return a list of unapproved reviews.
4.1 System does not update the database, message returned to user is: “Review not Approved”
Success Guarantee Review is approved
Minimum Guarantee Employee will be able to try to approve the review again.

View Report

Use Case Name View Report
Description The employee views a report.
Actor(s) Employee
Preconditions Employee is logged in to the employee portal of the CVGS website.
Basic Flow of Events Actor System
1. Employee clicks “View Reports”
3. Employee selects a report.
2. System returns a list of available reports
4. System returns the selected report to the employee to view.
Alternate Flow(s) 2.1 System doesn't return a list of available reports.
4.1 System does not return the selected report.
Success Guarantee Selected report is returned for viewing.
Minimum Guarantee Employee will be able to try view the report again.