ADT Functional Spec Bug Tracker

7/31/2019 ADT Functional Spec Bug Tracker

1/19

Author Jason

Version 1.0

Printed 2001-10-2212:23 PM

ADT: Bu g Tr ack er

Ver sion 1 .0

Functional Specification


2/19

ADT: Bug Tracker Version 1.0 Functional Specifi cation

2 of 2 Author: Jason

Docum ent Rev is ions

Revisions on this document should be recorded in the table below:

Date Description Author

1 10 September 2001 First Draft Jason2 10 September 2001 First Edit Josh3 5 October 2001 Add Params, All Views, Screen Shots Josh

4


3/19



1 Introduction 41.1 Purpose of this document 41.2 Scope of this document 41.3 Overview 41.4 Business Context 4

2 General Description 4

2.1 Product Functions 42.2 General Constraints 4

3 Functional Requirements 113.1 Web Bug Tracker Application 11

3.1.1 Description...................................... ................................................. ............................... 113.1.2 Risks and Dependencies............................................ ................................................. ..... 18

4 Database Design 184.1 Description 18 4.2 Communications Interfaces 19

5 Other non-functional attributes 195.1 Reliability 19 5.2 Maintainability 19 5.3 Portabi lity 195.4 Extensibility 19 5.5 Reusabili ty 19 5.6 Serviceabili ty 19


4/19



1 I n t r o d u ct i on

1.1 Purpose o f t h is documentThe purpose of thi s document is to specify the functional and system specification of the BugTracker application. This document provides a road-map through which the implementation of theappli cation wil l be developed and, where applicable, wil l also contain information detail ingtechnical design constraints and assumptions.

1.2 Scope o f t h is docum ent

The scope of this specificati on covers the functional specificati ons of the Bug Tracker application.This specification does not extend to third party or infrastructure components (such as a web

server install ation and/or configuration).

1.3 Over v iew

The basic requirements summary build-in for the Web Bug Tracker appli cation: To able to store the bug l ist in the midst of e.g. UAT of a project. To able to separate view depending on the status of bug reported and also via different

user.

To define a basic data listing page for viewing purpose.

1.4 Business Cont ex tBug Tracker is a groupware application designed for multiple users over a wide area. The genericversion is open source for distribution. Anyone may take advantage of the powerful eXtropia PerlADT. Improvements will be made i ncrementall y as bug reports come i n and suggestions aremade. The generic Web Bug Tracker wil l ul timately benefit both the company and our users.

2 Genera l Descr ip t ion

2.1 Pro duct Funct ions

The general functionali ty of the Web Bug Tracker appl ication is to al low users to display the userBug Tracker information in a single l ocation onl ine. The appl ication generates a dynamic pagedepending on the entered information and the setup preferences.

2.2 Gene r a l Const r a in t s

Bold Params indicate Section Headings. Italic Paramsare objects.Indented Params are configurable variab les.

Grayed out or missing items are not required or not available in the default configuration.


5/19



Param Default configuration NotesLanguage Perl

Session SetupType File Note that flatfile data

sources are slow. Werecommend upgrading toa database based datasource

Max Modify Time 1 hourFatal Timeout OffFatal if session notfound

Off

Session Manager SetupType FormVarCgi Object $CGISession Params Session Config Params

Authentication Setup For the datasourceType FileField Delimeter I (pipe)Create a file if noneexists

On

Field Names From Auth User DatasourceFil e Scriptname.users.dat Path is set at start of

scriptDefault AuthenticationFields

Username, password,groups, firstname, lastname, emai l,developer_status

Authentication ManagerSetup

How requests areprocessed

Color for even rows E5E5E5Color for Odd Rows FFFFFFCSS View URL $CSS_VIEW_URLApplication Logo logo.gifApplication LogoHeight

40

Appli cation Logo Width 353Appli cation Logo ALT WebDB DemoHTTP Header Params [-EXPIRES => '-1d']Document Root URL / or web root di rectoryImage Root URL /Images/ExtropiaScript Display Name BugTrackerScript Name $CGI->script_name()

Page Top View PageTopViewPage Bottom View PageBottomViewLink Target _sel f or current window

User_Fields Auth_username, auth_password, auth_groups,auth_firstname, auth_lastname, auth_email ,auth_developer_status

Mail ParamsType Sendmail Default on most systems

User Mai l Send Params


6/19



From [email protected] Password Generated

Admin Mail Send ParamsFrom [email protected] [email protected] Registration Notification

Auth Manager Config ParamsType CGIAll ow Registration OnAl low User Search On Al low anyone to check for

an old account.Generate Password OffDefaul t Groups NormalEmail Registration toAdmin

Off

Display RegistrationAfter Fail ure

On

Upload Manager Setup For Attachments

Type SimpleCGI_OBJECT $CGIUpload Field attachField to set uploadfilename

attach_filename

Key Generator ParamsType RandomSecretElement

RECRUIT

Length 0UploadDirectory

$APP_DATAFILES_DIRECTORY/Uploads

Data Handler Setup How data is handledAdd Form DHM Config

Type CGICGI Object $CGIData Handlers Emai l, Exists, HTML, String, UploadField Mappings Abstract, priority, reporter, developer, detai ls,

status, attach, resolution_text

Datasource Setup Configure the databaseand fields displayed

Field Names record_id, abstract, priority, reporter, developer,detai ls, status, attach, attach_fil ename,resolution_text, resolution_date, accepted_by,accepted_date, username_of_poster,

group_of_poster, date_time_posted

Corresponds to defaultextropia database

Sample Default WidgetDefinitions

Configure fie ld types forTTML

Display Name Country Name that appears in thebrowser

Type Textfield, textarea, popup_menuName Fname Internal field nameSize 30 Display size in charactersMaxlength 80 Maximum number of


7/19


8/19



DetailsRecordView, AddAcknowledgementView,AddRecordConfirmationView,DeleteRecordConfirmationView,DeleteAcknowledgementView,ModifyAcknowledgementView,ModifyRecordConfirmationView,

ModifyRecordView, PowerSearchFormView,SessionTi meoutErrorView, LogoffView,OptionsView,

display views that are notavailable here.

View Display Params Defaults for ViewsApplication Logo logo.gifApplication LogoHeight

40

Appli cation Logo Width 353Appli cation Logo ALT WebDB DemoHTTP Header Params [-EXPIRES => '-1d']Document Root URL /Image Root URL /Images/Extropia You should changes this

upon installation to beoutside the cgi directory.

Script Display Name Bug Tracker

Color for Even Rows E5E5E5Color for Odd Rows FFFFFFDisplay Fields abstract, priori ty, reporter, developer, detail s,

status, resolution_date, resolution_text,accepted_date, accepted_by, attach,

Table BG Color 1 6699CCTable BG Color 2 E5E5E5Table BG Font Color 1 BLACKTable BG Font Color 2 BLACK

Filter SetupHTMLIZE Filter

Type HTMLizeConvert DoubleLinebreak to P

On

Convert Linebreak toBR

On

Charset Fil terType CharSet

Embed FilterType EmbedEnable Off

Action/Workflow Setup

Action Handler List Defaul ts User should not need tomodifyAction Handler Action Params

Action Handler List \@ACTION_HANDLER_LISTAdd AcknowledgmentView Name

AddAcknowledgementView

Add Emai l Body View AddEventEmailViewAdd Form View Name AddRecordViewAllow Additions Flag On


9/19



Allow Deletions Flag OnAl low Dupl icate Entries OffAllow Username Fieldsto be Searched

On

Allow ModificationsFlag

On

Appli cation Sub MenuView Name

ApplicationSubMenuView

Options Form ViewName

OptionsView

Auth Manager ConfigParams

\@AUTH_MANAGER_CONFIG_PARAMS

Add RecordConfirmation ViewName

AddRecordConfirmationView

Basic Data View Name BasicDataViewCGI Object $CGICSS View URL $CSS_VIEW_URL For speed, change CSS

URL to a location outsidethe CGI directory.

CSS View Name CSSViewDatasource ConfigParams

\@DATASOURCE_CONFIG_PARAMS

DeleteAcknowledgment View

DeleteAcknowledgementView

Delete Record ConfirmView

DeleteRecordConfirmationView

Records Per PageOptions

[5, 10, 25, 50, 100] Remove or changenumbers as desired. Thisappears under Options.

Max Records PerPage

$CGI->param('records_per_page') || 5

Sort Field 1 $CGI->param('sort_field1') || 'category Sort by which field?Sort Field 2 $CGI->param('sort_field2') || 'fname Sort by which field?Sort Direction $CGI->param('sort_di rection') || 'ASC' ASC=Ascendi ng,

DSC=DescendingDelete Form ViewName

BasicDataView

Delete Email BodyView

DeleteEventEmailView

Details View Name DetailsRecordViewData Handler ManagerConfig Param

\@DATA_HANDLER_MANAGER_CONFIG_PARAMS

DisplayAcknowledgement OnAdd

On

DisplayAcknowledgement OnDelete

On

DisplayAcknowledgement OnModify

On

Display ConfirmationOn Add

Off


10/19



Display ConfirmationOn Delete

Off

Display ConfirmationOn Modify

Off

Enable Sorting OffDefault Sorting Field1 titleDefault Sorting Field2 abstractHidden Admin FieldsView

HiddenAdminFieldsView

Input WidgetDefinitions

\@INPUT_WIDGET _DEFINIT IONS

Key Field record_idLogoff View LogoffViewURL Encoded AdminFields View

URLEncodedAdminFieldsView

Log Config Params ModifyAcknowledgementViewModifyAcknowledgment View

ModifyRecordConfirmationView

Mai l Config Params \@MAIL_CONFIG_PARAMSModify Form View ModifyRecordViewModify Email BodyView

ModifyEventEmailView

Power Search View PowerSearchFormViewRequire Auth toSearch

On Is authorization requiredfor the action?

Require Auth for Add On Is authorization requiredfor the action?

Require Auth forModify


Require Auth forDelete


Require Auth forDetails


Require MatchingUsername for Modi fy

Off Is a matching group orusername requi red forthe action on that record?

Require MatchingGroup for Modify


Require MatchingUsername for Delete


Require MatchingGroup for Delete


Require MatchingUsername for Search


Require MatchingGroup for Search


Send Emai l on Delete OffSend Emai l on Modify OffSend Email on Add Off


11/19



Session Object $SESSIONSession Timeout View SessionTi meoutErrorViewTemplates CacheDirectory

$TEMPLATES_CACHE_DIRECTORY

Val id Views \@VALID_VIEWSView Display Params \@VIEW_DISPLAY_PARAMSView Filters ConfigParams

\@VIEW_FILTERS_CONFIG_PARAMS

View Loader $VIEW_LOADERSimple Search String $CGI->param('simple_search_string') || ""First Record on Page $CGI->param('first_record_to_display') || 0Last Record on Page $CGI->param('first_record_to_display') || "0"Page Top View PageTopViewPage Bottom View PageBottomViewAction Handler Plugins \%ACTION_HANDLER_PLUGINS,

3 Func t i ona l Requ i rem en ts

3.1 W eb Bug Tr acker App lica t ion

3.1 .1 Descr ip t ion

The following definitions only cover the Default settings and views.

Authentication Definition View sThe appli cation will all ow any user read-only rights to view the records registered in theappl ication. Only registered users however, may add, modi fy, and delete records. There is nocapacity for multiple group definitions, thus the default group is Normal and cannot be changed.

Default Settings Permit: Registered developers or testers may view the database Any registered user may search the database

Registered users may add, modi fy, and delete records Registration is available to anyone

Registration of normal users is simply done by pressing Logon and following the RegistrationViews. User data is written to the datasource. In the defaul t install ation , it is written to

Datafiles/BugTracker/bug_tracker.users.dat . It is recommended that admin istratorsdo not a lter the contents, especia ll y the encrypted passwords. The information is listed as:

username|password|group_name|fname|lname|email|dev_status

Registration of Administrative users may be done at a later date. System administrators will beable to al ter hard data i n databases or flatfiles as needed.

- Logon View requests the Username and Password of registered users. Users may attempt tologon, Register, or Search for Account. Also the view for failed log ins.


12/19



- Register View permits any user to enter Username, Password, Confirm, Password, First Name,Last Name, E-Mail , and Developer Status. The user may then Register or Return to LogonScreen.

- Register Confirmation View confirms registration and returns the user to the Logon View.


13/19



- Search for Account requests an email address to match users and then sends the password tothe user.

- Search for Account Users Found displays the username that matches the emai l address given.


14/19



- Search for Users No Results appears when no email address is associated with a username.

- Logoff View logs the user out and confi rms the l ogoff. The session is terminated.


15/19



View Definition- Show All Open Bugs displays al l Open bug records.

- Show All Bugs displays all bugs.

- Show Open Bugs Posted To Me displays all Open bugs posted to the developer logged in.

- Show All Bugs Posted To Me displays all bugs posted to the developer logged in.

- Show Open Bugs Posted By Me displays all Open bugs posted by the current user.

- Show All Bugs Posted By Me displays all bugs posted by the current user.

- Add Record permits the user to add a bug. Fiel ds include: Abstract, Priority, Reported by,Developer, Detail s, Status, Accepted By, Accepted Date, Problem Resolution, Resolution Date,and Attachment.


16/19



- Modify Record permi ts the modi fication of exi sting records. The user may update the fi elds asnecessary.

- Delete Record Acknowledgment is displayed after a user presses Delete in the Details View.There is no request to confirm deletion.


17/19



- Details View displays the information in a record. Modify and Delete options are available.

- Advanced Search permi ts any user to search the database for any or al l o f the available fields.

- Acknowledgment View is displayed whenever someone successful ly Adds, Modifies, or Deletesa Record.

- Confirmation View is displayed whenever someone attempts to Add, M odi fy, or Delete aRecord. This is not on by default.


18/19



Common Features Definitions

- Basic Search permi ts any user to search the database based upon keywords. Avai lable i n theheader.

- Options View permits the authenticated user to al ter Records Displayed per Page, T wo SortFields, and which Col umns to View. Upon pressing View as Defined, the user will see the recordsas desired. The Viewable Columns will vary according to Application.

3.1 .2 Risks and Depen den cies

4 Da tabase Des ign

4.1 De scr ipt ion

The data of the appli cation will be stored in a flat file. Each data fiel ds of a record will beseparated by |.

Fieldname Descriptionrecord_id Record value ( auto incremental )abstract The abstract of the bugpriority Priority of the bug reported.reporter Name of the person who report the bug.

developer Name of the developer who responsib le for this bug.detai ls Details of the bug being reported.status Status of the bug reported to display its status, whether has it

been fixed.attach Supporting document for the bug reported to be attached here.attach_filenam e Filename of the attachment above.resolu tion_text Solution to the bug fixed to be entered here.resolu tion_date Resolve date of the bug fix.accepted_by Name of the Bug fix acceptance.


19/19



accepted_date Date when the bug fix is accepted.username_of_poster Userid of login user who posted this recordgroup_of_poster Group of the login user who posted this record. Eg ( admin

group, developer group etc.date_time_posted Date and Ti me posted of record

4.2 Com mun ica t ions I n t e r faces

5 Ot h e r n o n - f u n c t i o n al at t r i b u t e s

5.1 Re liab ilit y

Highly reliable in a properly secured environment.

5.2 Maint ainabi lit y

Requi res littl e maintenance. Owners wil l want to clear out a large flat-file now and then as well asensure their installation is secure from hackers. Users of relational databases will probably notneed to clear out their database.

A modular architecture provides easy maintenance and upgrades.

5.3 Por ta b ilit y

5.4 Ex t en sibi lit yInformation entered via Web Bug T racker is portable to any relati onal database. The program caneasil y be switched to a new database with just a few lines of code. The program relies on theeXtropia ADT that divorces form and function.

5.5 Re usab ilit y

Web Bug Tracker is highly reusable. The appl ication can be modi fied for just about anything!

5.6 Ser vicea bi lit y

Documents

ADT Functional Spec Bug Tracker