DOC

Business Requirements Document

By Ricardo Richardson,2014-06-22 13:05
7 views 0
Business Requirements Document

    IT PROJECT WRITING SAMPLE

     Business Requirements Document

    Author Christina Lee

    Status Final

    Revision Version 2.0

    Creation Date 01/01/2009

    Last Updated 01/05/2009

     IT Project Writing Sample

     Business Requirements Document

    Document Review and Approval Revision History:

    Version Author Date Revision

    1.0 Christina Lee 1/1/09 Initial draft

    2.0 Christina Lee 1/5/09 Modifications per document review

    Reviewers:

     Reviewer Date Reviewed 1 Stakeholder 1 1/5/09 2 Stakeholder 2 1/5/09 3 Stakeholder 3 1/5/09 Approved By:

     Project Sponsors Date Reviewed

     Name Signature 1 Stakeholder 1 Stakeholder 1 1/10/09 2 Stakeholder 2 Stakeholder 2 1/10/09 3 Stakeholder 3 Stakeholder 3 1/10/09

    October 26, 2009 Page 2 of 13

     IT Project Writing Sample

     Business Requirements Document

    Table of Contents

    1 EXECUTIVE SUMMARY ........................................................................................................................... 4 1.1 PROJECT DESCRIPTION ........................................................................................................................... 4 1.2 PROJECT SCOPE ...................................................................................................................................... 4 1.3 ASSUMPTIONS ........................................................................................................................................ 5 1.4 SUCCESS CRITERIA ................................................................................................................................. 5 2 BUSINESS REQUIREMENTS .................................................................................................................... 6 2.1 RQMT # 1: APPLICATION SECURITY AND AUDIT ..................................................................................... 6

    2.1.1 Security Roles ...................................................................................................................... 6

    2.1.2 User Activity Audit ................................................................................................................ 6 2.2 RQMT # 2: REPORTS .............................................................................................................................. 7

    2.2.1 Image History Report ............................................................................................................ 7

    2.2.2 User Activity Audit Report ..................................................................................................... 7 2.3 RQMT # 3: MODIFICATIONS TO THE USER INTERFACE ............................................................................. 8

    2.3.1 Modification to Application / Subject Dropdowns ................................................................... 8

    2.3.2 Modification Filtering ............................................................................................................. 8

    2.3.3 Modification to Image List ..................................................................................................... 8

    2.3.4 Introduction of UPC Code to the Image Attributes ................................................................. 9 2.4 RQMT # 4: MANUAL IMAGE UPLOAD AND UPDATE................................................................................. 9

    2.4.1 Individual Image Upload and Edit.......................................................................................... 9

    2.4.2 Bulk Upload .......................................................................................................................... 9 2.5 RQMT # 5: KEYWORDS AND ATTRIBUTES ............................................................................................. 10

    2.5.1 Addition of Keywords .......................................................................................................... 10 2.6 RQMT # 6: IMAGE RESOLUTION ........................................................................................................... 11

    2.6.1 Screen Resolution Adjustment ............................................................................................ 11

    2.6.2 High Resolution Images ...................................................................................................... 11 2.7 RQMT # 7: IMAGE DUPLICATION AVOIDANCE ...................................................................................... 11

    2.7.1 Preventing Duplicate Images .............................................................................................. 11 3 APPENDIX A SECURITY MATRIX ..................................................................................................... 13

    October 26, 2009 Page 3 of 13

     IT Project Writing Sample

     Business Requirements Document

1 Executive Summary

    1.1 PROJECT DESCRIPTION

    Currently there is no method to track or audit changes to imaging data in the Imaging Repository (IR), and no status or job logging is taking place. In the event that there were a failure or breakage in the system, it would be impossible to properly diagnose the cause or source of the issue because of the lack of thorough record keeping for the movement of data in the system. There is also no clearly defined security role to distinguish who should have access to make changes to the image database, and who should have read-only access. As a result, manual uploading and editing of the image records has been disabled until a time that these functions can be better secured.

    In addition to the need for better security and record keeping protocol, the user community has requested a number of enhancements to the user interface that will allow them to make better use of the IR system in order to perform their job functions. Among these enhancements would be changes that would permit easier and more logical sorting and filtering, and more search capability by implementing the use of keywords.

    The goal of Imaging Repository Release 2.0 is to make changes and enhancements to the system that will allow for more secure content management, while providing more user friendly functionality to the user interface.

1.2 PROJECT SCOPE

    The following items are in scope for the current phase of this project:

    ; Application security and audit:

    ; Definition and creation of security roles to control upload capability and access

    ; Ability to restrict image viewing or updates of proprietary images based on customer identity

    ; Creation of audit and logging records so changes to the database can be properly secured

    and managed

    ; Reports:

    ; User activity audit report

    ; Image activity history report

    ; Modifications to the user interface:

    ; In the user interface, modification of the subject dropdown to make it dependent upon the

    application dropdown in order to provide a more logical filter to the user community.

    ; Ability to assign unique customer identifiers for customer specific images

    ; Ability to search and retrieve images using either global or customer specific identifiers

    ; Modification to the list of images to provide more versatility in viewing and sorting file details.

    ; Addition of UPC code in image attribute data

    ; Implementation of a standard unique identifier for global images

    ; Retrieval of UPC codes from the records database for images using alternate identifiers. ; Manual image upload and update:

    ; Activation of upload functionality in the application for administrator roles

    ; Creation of a notification method to inform users when uploads are successful (or

    unsuccessful)

    ; Creation of method to view a count of records uploaded.

    ; Ability to flag 'proprietary' images during individual and bulk upload

    ; Keywords and attributes:

    ; Allow addition of keywords and attributes to files that can be used for searches October 26, 2009 Page 4 of 13

     IT Project Writing Sample

     Business Requirements Document

     Allow inclusion of keywords in manual uploads to the appropriate security role

    ; Allow ability to search keywords and attributes, including the use of wildcard searches ; Image resolution

    ; Allow ability to store and access high resolution images

    ; Adjust image resolution from 800x600 to 1024x768 in viewer window

    ; Image duplication avoidance

    ; Procedures to streamline the image upload process in order to eliminate unnecessary

    duplication of images.

    The following items are out of scope for the current phase of this project: ; Re-rendering of the original uploaded image beyond standard processing required to display images

    in the Image Repository application or on existing reports

    ; Elimination of duplicate images already residing in the repository database ; Inclusion of additional sales attributes from the data warehouse beyond those already in use by the

    Image Repository system

    ; Retention limit and purge process for published images (Future phase)

    ; Requirement is to retain published images for current calendar year + previous four calendar

    years, for a total of five years

    ; Currently we do not have 5 years accumulated images, so there is no need to implement this

    at the present time. Once we have over 5 years of images accumulated, we can begin the

    purge process.

1.3 ASSUMPTIONS

    ; All images being used by the application will be centrally located in the image repository ; All images sent and received will be in .JPG or .GIF format.

    ; Governance rules will be implemented to avoid duplicity

1.4 SUCCESS CRITERIA

    ; The solution is complete all documented requirements are implemented.

    ; The solution is accurate all documented requirements are implemented according to specifications ; The solution is timely the solution is delivered in a timeframe that is executable and usable by the

    Project Team.

    October 26, 2009 Page 5 of 13

     IT Project Writing Sample

     Business Requirements Document

    2 Business Requirements

    2.1 RQMT # 1: APPLICATION SECURITY AND AUDIT

    For the security matrix, see Appendix A of this document.

2.1.1 Security Roles

    1. Need to define access and privileges based on function and Application / Subject Area.

    2. Need to define three types of user profiles:

    ; Application Support Administrator Profile Manage application and users

     Be able to Upload, Edit and View All Images

     Be able to create and modify User Profiles.

     Be able to create new User IDs and assign them to User Profiles.

     Be able to assign User Profiles to Data Groups

     Be able to view user audit report

     Be able to view image transaction history

    ; Image Administrator Profile Manage images

     Be able to upload, edit and view all application / subject specific images assigned to

    their security role

     Be able to upload, edit and view all global images

    ; Standard User Profile Search and retrieve images

     Be able to search on and view all application / subject specific images assigned to

    their security role

     Be able to search on and view all global images

2.1.2 User Activity Audit

    1. Need to maintain a user audit trail record with the following values

    ; User ID

    ; Transaction type

    ; Transaction date-time

    ; Image key attribute / unique identifier

    2. Data would be logged to a file for each transaction that results in an insert or update to the

    Image Repository databases.

    3. Activity such as logging on or off the system would not need to be captured.

    October 26, 2009 Page 6 of 13

     IT Project Writing Sample

     Business Requirements Document

    2.2 RQMT # 2: REPORTS

2.2.1 Image History Report

    1. Provide a simple text detail of the image history on the image screen 2. Report will be accessible by the application administrator role only. See Appendix A for more

    information about roles.

    3. Administrator can access image history via a link on the image screen. 4. Report details will include:

    ; Activity date (sort descending)

    ; Activity type

    ; User ID

    5. Include system details, (i.e. automated upload date-time)

2.2.2 User Activity Audit Report

    1. This report will be available to the application administrator role only, for the purposes of

    troubleshooting and support. See Appendix A for more information about roles. 2. This report will utilize the audit information available in the User Activity Audit file (see section

    2.1.2 of this document).

    3. Need to provide application administrator ability to pull user activity using the following filters:

    ; User name / ID (mandatory)

    ; Start and end dates (mandatory, can be same date)

    4. Report should display the following information:

    ; User ID

    ; Transaction Date (sort descending)

    ; Transaction type performed

    ; Image file name

    ; Unique image key

    5. Provide the application administrator the ability to export the user activity report to .CSV /

    Excel format as needed.

    October 26, 2009 Page 7 of 13

     IT Project Writing Sample

     Business Requirements Document

    2.3 RQMT # 3: MODIFICATIONS TO THE USER INTERFACE

2.3.1 Modification to Application / Subject Dropdowns

    1. Need to change the name of the periodical application to “Published” in order to more

    accurately describe the images contained in that application / subject group, and also allow it

    to be a more universal application for future inclusion.

    2. Need to add a new application called “Global” for non-proprietary images that don‟t fit in the

    other applications. This application will also need to be made available in the upload screens. 3. Need to add the subject “Audit” to properly identify uploaded store check images. This

    subject will also need to be made available in the upload screens.

    4. Need to make the Subject dropdown items dependent upon the Application dropdown items:

    ; When the application dropdown contains '---', the subject dropdown should list all

    available subjects permitted by the user‟s security role

    ; Application dropdown should only offer applications permitted by the user‟s security role

    ; When application dropdown contains a value other than '---', only subjects valid to that

    particular application should be listed in the subject dropdown list.

    Subject: Application: Audit Published V1_Product V2_Product*

    Global X

    Published X

    Vendor1 X

    Vendor2 * X

    * The Vendor2 application and subject are no longer valid and will be phased out in a

    future phase.

    5. The addition of future applications and subjects to the Image Repository will require definition

    of the relationship between them and the user role before they can be implemented.

2.3.2 Modification Filtering

    1. Need to be able to filter out unwanted image results

    ; Need to be able to filter images with a date range

    ; Need to be able to filter by retailer

    2. In-bound Published images currently utilize a naming convention for published images that

    provides the file date, retailer name, and page number. Requirement is to derive this

    information from the file name and provide each piece of information as searchable individual

    attributes.

2.3.3 Modification to Image List

    1. Need to establish a new default sort on image search results that is more logical to the

    operations of the business. Currently the image results that are returned are sorted in

    descending order on the image key. The preferred default sort for images would be as

    follows:

    First - Date (descending)

    Second - Retailer (ascending)

    Third - Page number (ascending)

    2. Need to provide a greater level of customization to the image list screen to enable viewing of

    additional details and the ability to sort on them (similar to Windows Explorer).

    ; Need to be able to view and sort on full file name

    October 26, 2009 Page 8 of 13

     IT Project Writing Sample

     Business Requirements Document

    ; Need to be able to view and sort on upload date

    ; Published Images need to be able to sort on date and retailer

    ; Need to be able to export search results to Excel; Export columns should include

    available attributes and keywords

2.3.4 Introduction of UPC Code to the Image Attributes

    1. Need to create a non-customer specific, global identifier for all images. The UPC / EIN code

    has been identified as a viable solution.

    ; When possible, the UPC code will be added during the upload process.

    ; Images that contain an alternate key in their attributes will have their UPC code

    automatically retrieved from the records database.

    2. For future additions to the Image Repository, UPC code retrieval will need to be factored in

    as part of the project effort.

    2.4 RQMT # 4: MANUAL IMAGE UPLOAD AND UPDATE

2.4.1 Individual Image Upload and Edit

    1. Need to provide a means to upload individual images by the user

    o Enable existing upload capability

     Upload rights will be granted to Admin roles only (See Appendix A for roles)

     Ability to submit attribute information for uploaded image including Keywords

    o Provide upload confirmation / failure dialogue

     Dialogue should include the following information:

    o File name

    o Timestamp

    o Message text “Image was successfully uploaded”

     Upload failure dialogue should contain the following information:

    o File name

    o File size

    o Timestamp

    o Informative description of error condition, (i.e. “File must be type .jpg or .gif”)

    2. Need to provide a means to edit image attributes in the user interface

    o Update rights will be granted to Admin roles only (See Appendix A for roles)

    o Ability to modify the following attribute information in the image screen:

     Merchant specific image identifier (i.e. AltKey)

     UPC / EIN

     Proprietary (Customer Specific) Flag

     Keywords

2.4.2 Bulk Upload

    1. Need to provide a method for uploading multiple images at a time

    o Enable “Bulk Upload” functionality

     Upload rights will be granted to Admin roles only (See Appendix A for roles)

     Clicking the bulk upload button should open a file selection popup that allows multiple

    selection using either „Shift‟ or „Control‟ keys

    October 26, 2009 Page 9 of 13

     IT Project Writing Sample

     Business Requirements Document

     Bulk upload dialogue will provide a method for marking images as proprietary

    o Default will be non-proprietary / global

    o Proprietary indicator will be applicable to all image files in batch

     Bulk upload will import the image files and assign name, attributes, and stamp with

    an upload date-time based on a set of rules:

    o Existing rules for Vendor1 published image upload uses the following naming

    convention:

    Published Images

    YYYYMMDD_(Retailer)_(Pg#).jpg

    Vendor1 Product

    AltKey.jpg

    o Proposed naming rules incorporating Keywords:

    Published Images

    YYYYMMDD_(Retailer)_(Pg#)_KEYWORD1_KEYWORD2_KEYWORD3.jpg

    Vendor1 Product

    AltKey_KEYWORD1_KEYWORD2_KEYWORD3.jpg

    Global Store_Audit

    YYYYMMDD_(Retailer)_UPC_KEYWORD1_KEYWORD2_KEYWORD3.jpg

    o These rules are specific to published images, store check, and Vendor1 Product

    images only. Future customer product images will require naming conventions

    with processing rules before they can be implemented to the image repository.

2. Provide descriptive upload confirmation / failure dialogue

    o Dialogue should include the following information in list format:

     Each file name

     Each file size

     Each file timestamp

     Count of records uploaded

     Message text “These images were successfully uploaded”

    o Upload failure dialogue should contain the following information:

     File name for failed file

     File size

     Timestamp

     Informative description of error condition, (i.e. “File must be type .jpg or .gif”)

    o Image files that fail during bulk upload should not interrupt overall bulk upload process

    2.5 RQMT # 5: KEYWORDS AND ATTRIBUTES

2.5.1 Addition of Keywords

    1. Definition of a keyword for the purposes of this application:

    ; A keyword is a specific word, title, name, or search term that is used as a very high level

    filtering device

    October 26, 2009 Page 10 of 13

Report this document

For any questions or suggestions please email
cust-service@docsford.com