Database Specification Template

14
7/21/2019 Database Specification Template http://slidepdf.com/reader/full/database-specification-template 1/14 Revision Sheet Database Specifications Page i

description

Database specifications

Transcript of Database Specification Template

Page 1: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 1/14

Revision Sheet

Database Specifications Page i

Page 2: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 2/14

Revision Sheet

DATABASE

SPECIFICATIONS

Revision Sheet

Release No. Date Revision Description

Rev. 0 5/30/00 Database Specifications Template and Checklist

Rev. 1 4/10/02 Convesion to !"RD 2000 fomat

Database Specifications Page ii

Page 3: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 3/14

Database Specifications Authorization

Memorandum

# have caef$ll% assessed the Database Specifications fo the &S%stem 'ame(. This doc$ment has beencompleted in accodance )ith the e*$iements of the +,D S%stem Development -ethodolo%.

-'-'T CRT##CT#"' lease check the appopiate statement.

  The doc$ment is accepted.

  The doc$ment is accepted pendin the chanes noted.

  The doc$ment is not accepted.

!e f$ll% accept the chanes as needed impovements and a$thoi6e initiation of )ok to poceed. 7ased ono$ a$thoit% and 8$dment9 the contin$ed opeation of this s%stem is a$thoi6ed.

    '- DTo8ect :eade 

    '- DT"peations Division Diecto 

    '- DToam ea/Sponso Repesentative

    '- DToam ea/Sponso Diecto 

Database Specifications Page iii

Page 4: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 4/14

DATABAS SP!"#"!AT"$NS

TAB% $# !$NTNTS

ae ;

1.0 'R: #'"R-T#"'...............................................................................................................

1.1 $pose.......................................................................................................................................1.2 Scope..........................................................................................................................................1.3 S%stem "vevie)........................................................................................................................1.4 o8ect Refeences.................................................................................................................... ..1.5 con%ms and bbeviations......................................................................................................1.< oints of Contact........................................................................................................................

1.<.1 #nfomation...................................................................................................................................1.<.2 Coodination.................................................................................................................................1.<.3 dditional oints of Contact........................................................................................................1.<.4 Data ")nes.................................................................................................................................

2.0 DT7S #D'T##CT#"' 'D DSCR#T#"'............................................................... ......

2.1 'amin Conventions...................................................................................................................2.2 Database #dentification...............................................................................................................2.3 S%stems ,sin the Database...................................................................................................... .2.4 Relationship to "the Databases.................................................................................................2.5 Schema #nfomation....................................................................................................................

2.5.1 Desciption....................................................................................................................................2.5.2 h%sical Desin.............................................................................................................................2.5.3 h%sical St$ct$e.........................................................................................................................

2.< Data Dictiona%..........................................................................................................................2.= Special #nst$ctions.....................................................................................................................

3.0 DT7S D-#'#STRT#> #'"R-T#"'...................................................................... .....

3.1 Responsibilit%.............................................................................................................................3.2 S%stem #nfomation.....................................................................................................................

3.2.1 Database -anaement S%stem &D7-S( Confi$ation..............................................................3.2.2 +ad)ae Confi$ation...............................................................................................................3.2.3 Database Soft)ae ,tilities...........................................................................................................3.2.4 S$ppot Soft)ae vailable fo -aintainin Database................................................................3.2.5 Sec$it%.........................................................................................................................................

3.3 Stoae Re*$iements.................................................................................................................3.4 Recove%.....................................................................................................................................3.5 atition/ile #nfomation............................................................................................................

3.5.1 Content..........................................................................................................................................3.5.2 Desciption....................................................................................................................................3.5.3 atition/ile #ntedependencies...................................................................................................

3.< Database #ntefaces.....................................................................................................................3.<.1 Desciption of "peational #mplications......................................................................................3.<.2 Desciption of Data Tansfe Re*$iements.................................................................................3.<.3 Desciption of omats of Data....................................................................................................

3.= o +andlin............................................................................................................................

Database Specifications Page iv

Page 5: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 5/14

&.' (eneral "nformation

1.0 GENERAL INFORMATION

Database Specifications

Page 6: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 6/14

&.' (eneral "nformation

 NOTE TO AUTHOR:  Highlighted, italicized text throughout this template is provided solely asbackground information to assist you in creating this document. Please delete all such text, as well asthe instructions in each section, prior to submitting this document. ONLY YOUR PROJECT-

 SPECIFIC INFORMATION SHOULD APPEAR IN THE FINAL VERSION OF THIS 

 DOCUMENT .

The Database pecifications are intended to support program coding and database generation by thedevelopment group. The database structure, content, data fields, and records are defined.

1.0 GENERAL INFORMATION

1.1 Purpose

Descibe the p$pose of the Database Specifications.

1.2 Scope

Descibe the scope of the Database Specifications as it elates to the po8ect.

1.3 Syste O!er!"e#

ovide a bief s%stem ovevie) desciption as a point of efeence fo the emainde of the doc$ment. #naddition9 incl$de the follo)in?

• Responsible oani6ation

• S%stem name o title

• S%stem code

• S%stem cateo%

−  !a"or application? pefoms cleal% defined f$nctions fo )hich thee is a eadil%

identifiable sec$it% consideation and need

− #eneral support system? povides eneal D o net)ok s$ppot fo a vaiet% of $ses

and applications

• "peational stat$s

− "peational

− ,nde development

− ,ndeoin a ma8o modification

• S%stem envionment and special conditions

1.$ Pro%ect Re&ere'ces

Database Specifications Page &

Page 7: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 7/14

&.' (eneral "nformation

ovide a list of the efeences that )ee $sed in pepaation of this doc$ment.  $xamples of referencesare%

• evio$sl% developed doc$ments elatin to the po8ect

• Doc$mentation concenin elated po8ects

• +,D standad poced$es doc$ments

1.( Acro'ys )'* A++re!")t"o's

ovide a list of the acon%ms and abbeviations $sed in this doc$ment and the meanin of each.

1., Po"'ts o& Co't)ct

1.,.1 I'&or)t"o'

ovide a list of the points of oani6ational contact &"Cs( that ma% be needed b% the doc$ment $se fo infomational and to$bleshootin p$poses. #ncl$de t%pe of contact9 contact name9 depatment9 telephonen$mbe9 and email addess &if applicable(. oints of contact ma% incl$de9 b$t ae not limited to9 helpdesk "C9 development/maintenance "C9 and opeations "C.

1.,.2 Coor*"')t"o'

ovide a list of oani6ations that e*$ie coodination bet)een the po8ect and its specific s$ppotf$nction &e..9 installation coodination9 sec$it%9 etc.(. #ncl$de a sched$le fo coodination activities.

1.,.3 A**"t"o')- Po"'ts o& Co't)ct

dditional points of contact ae incl$ded in section 3.1.

1.,.$ D)t) O#'ers

#dentif% points of contact fo those )ho eithe o)n o ae esponsible fo data *$alit%9 c$enc%9 acc$ac%9etc.

Database Specifications Page )

Page 8: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 8/14

).' Database "dentification and Description

2.0 DATABASE IDENTIFICATION AND DESCRIPTION

Database Specifications

Page 9: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 9/14

).' Database "dentification and Description

2.0 DATABASE IDENTIFICATION AND DESCRIPTION

2.1 N)"' Co'!e't"o's

Disc$ss the loical and ph%sical namin standads and conventions.

2.2 D)t)+)se I*e't"&"c)t"o'

#dentif% the names o labels b% )hich the database ma% be $ni*$el% identified. Specif% the code name9 ta9o label b% )hich each database table o file ma% be $ni*$el% identified.

 Descriptive information may also be provided.

2.3 Systes /s"' te D)t)+)se

#dentif% the s%stems that )ill $se the database. #ncl$de the f$ll s%stem identification and model9modification9 vesion n$mbe9 and #S s%stem code.

2.$ Re-)t"o's"p to Oter D)t)+)ses

#ndicate )hethe the database )ill s$pesede o inteface )ith othe databases9 and specif% )hich one&s(.

2.( Sce) I'&or)t"o'

Descibe the oveall st$ct$e in the schema o othe lobal definition of the database.

2.(.1 Descr"pt"o'

Descibe the schema and each s$bschema of the s%stem incl$din name9 file t%pe and name9 datadesciption lan$ae9 access contol ke%s9 conc$ence lockin9 data name mappin9 oveall patition/filelimitations and contols9 edefinition and access path estictions and an% othe limitations o estictions.

2.(.2 Pys"c)- Des"'

aphicall% depict the ph%sical desin of the database.

2.(.3 Pys"c)- Structure

Descibe and depict in a aphic epesentation the ph%sical st$ct$e &patitions9 files9 inde@es9 pointes(and the loical components of the database. #dentif% the citeia e*$ied to achieve opeatin efficienc%.

2., D)t) D"ct"o')ry

Refeence the data dictiona% and attach it as an appendi@ to this doc$ment.

Database Specifications Page &

Page 10: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 10/14

).' Database "dentification and Description

2. Spec")- I'struct"o's

#dentif% inst$ctions to be follo)ed b% pesonnel )ho )ill contib$te to the eneation of the database and)ho )ill $se it fo testin and opeational p$poses. S$ch inst$ctions ma% incl$de?

•#dentif% an% speciali6ed citeia fo entein data into the database.

• #dentif% so$ce doc$ments fo the $les and poced$es to be follo)ed )hen s$bmittin data fo 

ent% into the database.

• #dentif% so$ce doc$ments fo the machine $n inst$ctions fo eneatin9 modif%in9 $pdatin9 o 

othe)ise $sin the database. #n ve% lae s%stems9 in )hich the details of s$ch inst$ctions aee@tensive9 efeence sections of othe doc$ments in )hich this specific infomation ma% be fo$nd.

Database Specifications Page )

Page 11: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 11/14

*.' Database Administrative "nformation

3.0 DATABASE ADMINISTRATIE INFORMATION

Database Specifications

Page 12: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 12/14

*.' Database Administrative "nformation

3.0 DATABASE ADMINISTRATIE INFORMATION

3.1 Respo's"+"-"ty

#dentif% the oani6ations and pesonnel esponsible fo the follo)in database administative f$nctions?database administato9 s%stem administato9 and sec$it% administato. Descibe specific administationskill e*$iements.

3.2 Syste I'&or)t"o'

Doc$ment the Database -anaement S%stem confi$ation9 had)ae confi$ation9 database soft)ae$tilities9 and an% s$ppot soft)ae $sed. #f an% of these soft)ae elements o had)ae confi$ations aenot +,Dappoved standads9 indicate the date these items )ee appoved fo this po8ect b% theConfi$ation Chane -anaement 7oad &CC-7(.

3.2.1 D)t)+)se M)')ee't Syste DBMS4 Co'&"ur)t"o'

#dentif% the vendo9 vesion o elease date and taeted had)ae fo the D7-S. Descibe an% estictionson the initiali6ation and $se of the D7-S to s$ppot an% intended distib$ted pocessin.

3.2.2 5)r*#)re Co'&"ur)t"o'

#dentif% the had)ae confi$ations on )hich the database )ill eside.

3.2.3 D)t)+)se So&t#)re /t"-"t"es

:ist and efeence the doc$mentation of an% D7-S $tilit% soft)ae available to s$ppot the $se o maintenance of the database.

3.2.$ Support So&t#)re A!)"-)+-e &or M)"'t)"'"' D)t)+)se

Descibe all s$ppot soft)ae9 incl$din the opeatin s%stem9 diectl% elated to the database9 incl$dinname9 vesion9 f$nction9 and ma8o opeatin chaacteistics. Cite doc$mentation b% title9 n$mbe9 andappopiate sections. @amples of s$ch soft)ae incl$de database manaement s%stems9 *$e% lan$ae9epot )ites9 stoae allocation soft)ae9 database loadin soft)ae poams9 and file pocessin poams9 and data cleanin soft)ae.

3.2.( Secur"ty

Descibe the $se and manaement of inteit% and access contols that appl% to all database componentss$ch as schema9 s$bschema9 patitions o ph%sical files9 ecods o tables9 sets o elations9 and dataelements.

3.3 Stor)e Re6u"ree'ts

Database Specifications Page &

Page 13: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 13/14

*.' Database Administrative "nformation

Descibe the stoae device. ovide si6in fom$las fo deteminin the stoae e*$ied to s$ppot thedatabase content and associated soft)ae. stimate the intenal and peipheal stoae e*$iements.#dentif% m$ltiple stoae e*$iements fo distib$ted pocessin.

3.$ Reco!ery

Descibe the methodolo% fo eestablishment o eceation of the necessa% data schema and s%stems$ppot files.

3.( P)rt"t"o'7F"-e I'&or)t"o'

3.(.1 Co'te't

Descibe the content of each patition/file9 listin the ecods it contains and e@plainin the p$pose.

3.(.2 Descr"pt"o'

Descibe the desin and fomat of each patition/file9 incl$din name9 t%pe9 code9 mappin9 limitations andcontols9 access poced$es9 and mechanisms.

3.(.3 P)rt"t"o'7F"-e I'ter*epe'*e'c"es

#dentif% the intedependencies of each patition/file in the database.

3., D)t)+)se I'ter&)ces

ovide a desciption of the intefaces )ith othe application soft)ae incl$din these of othe opeationalcapabilities and fom othe oani6ations. o each inteface9 specif% the follo)in infomation?

3.,.1 Descr"pt"o' o& Oper)t"o')- Ip-"c)t"o's

Descibe opeational implications of data tansfe9 incl$din sec$it% consideations.

3.,.2 Descr"pt"o' o& D)t) Tr)'s&er Re6u"ree'ts

Descibe data tansfe e*$iements to and fom the soft)ae9 incl$din data content9 fomat9 se*$ence9 andan% convesion iss$es.

Database Specifications Page )

Page 14: Database Specification Template

7/21/2019 Database Specification Template

http://slidepdf.com/reader/full/database-specification-template 14/14

*.' Database Administrative "nformation

3.,.3 Descr"pt"o' o& For)ts o& D)t)

Descibe fomats of data fo both the sendin and eceivin s%stems9 incl$din the data item names9 codes9o abbeviations that ae to be intechaned9 as )ell as an% $nits of meas$e/convesion iss$es.

3. Error 5)'*-"'

Descibe those s%stem eo handlin o$tines and poced$es that ae available d$in e@ec$tion of database soft)ae.

Database Specifications Page *