O & M Manual Template

OPERATIONS & MAINTENANCE MANUAL Version <1.0> Date

[Insert appropriate Disclaimer(s)]

Titles you can't find anywhere else

Try Scribd FREE for 30 days to access over 125 million titles without ads or interruptions! Start Free Trial Cancel Anytime.





VERSION HISTORY [Provide [Provid e in inorm ormati ation on on !o" t!e dev develo elopme pment nt and dis distri tri#$t #$tion ion o t!e %&' 'an 'an$al $al em empla plate te "as con control trolled led and traced. traced. *se t!e ta#le #elo" #elo" to prov provide ide t!e version version n$m#er++ t!e a$t!or implementin, n$m#er implementin, t!e version+ t!e date o t!e version+ t!e name o t!e person approvin, t!e version+ t!e date t!at partic$lar ve rsion "as approved+ and a #rie description o t!e reason or creatin, t!e revised version.] Version # 1.0

Implemented B <-$t!or name>

Re!ision "te

Appro!ed B

Appro!l "te

Reson





Note to the Author !is doc$ment is a template o an Operations & Maintenance Manual doc$ment doc$ment or a project. !e template incl$des instr$ctions to t!e a$t!or+ #oilerplate tet+ and ields t!at s!o$ld #e replaced "it! t!e val$es speciic to t!e project. •

•

•

l$e italicied tet enclosed in s$are #racets ([tet]) provides instr$ctions to t!e doc$ment a$t!or+ or descri#es t!e intent+ ass$mptions and contet or content incl$ded in t!is doc$ment. l$e italicied tet enclosed in an,le #racets () indicates indicates a ield t!at s!o$ld #e replaced "it! inormation speciic to a partic$lar project. et and ta#les in #lac are provided as #oilerplate eamples o "ordin, and ormats t!at may #e et $sed or modiied as appropriate to a speciic speciic project. !ese are oered only as s$,,estions to assist in developin, project doc$ments2 t!ey are not mandatory ormats.

3!en $sin, t!is template or yo$r project doc$ment+ it is recommended t!at yo$ ollo" t!ese steps4 1. 5eplace all tet enclosed in a n,le #racets (e.,.+ ) "it! t!e correct ield val$es. !ese an,le #racets appear in #ot! t!e #ody o t!e t!e doc$ment and in !eaders and ooters. o c$stomie ields in 'icrosot 3ord ("!ic! display a ,ray #ac,ro$nd "!en selected)4 a. 6elec 6electt 7ile>Prope 7ile>Propertie rties>6$ s>6$mmar mmary y and ill in t!e itle itle ield ield "it! t!e Doc$ment Doc$ment Name Name and t!e 6$#ject ield "it! t!e Project Name. #. 6elect 6elect 7ile>Prop 7ile>Propertie erties>8 s>8$stom $stom and ill ill in t!e 9ast 'odiied+ 'odiied+ 6tat$s+ 6tat$s+ and :ersi :ersion on ields "it! t!e appropriate inormation or t!is doc$ment. c.

@.

-ter yo$ clic -ter clic %; to close close t!e dialo, dialo, #o+ #o+ $pdate $pdate t!e i ield elds s t!ro$,!o t!ro$,!o$t $t t!e doc$men doc$ment t "it! t!ese val$es #y selectin, dit>6elect dit>6elect -ll -ll (or 8trl=-) and pressin, 7. %r yo$ can $pdate an individ$al ield #y clicin, on it and pressin, 7. !is m$st #e done separately or ?eaders and 7ooters.

'odiy 'odi y #oilerpla #oilerplate te tet tet as appropr appropriate iate to to t!e speci speciic ic project project..

A. o add any ne" sections sections to t!e doc$ment doc$ment++ ens$re ens$re t!at t!e appropr appropriat iate e !ea !eader der and #ody tet tet styles style s are maintained. maintained. 6tyl 6tyles es $sed or t!e 6ection ?eadin,s ?eadin,s are ?eadin, 1+ ?eadin, @ and ?eadin, A. 6tyle $sed or #oilerplate #oilerplate tet is ody et. et. B. o $pdate $pdate t!e a#le a#le o 8on 8onten tents+ ts+ ri,!t= ri,!t=cli clic c and select select C*pdate C*pdate ield ield and c!o c!oose ose t!e option= option= C*pdate entire ta#le 5.

eore s$#mission o t!e irst drat o t!is doc$ment+ delete t!is CDoc$ment P$rpose pa,e and all instr$ctions instr$ctions to t!e a$t!or+ "!ic! "!ic! appear t!ro$,!o$t t!ro$,!o$t t!e doc$m doc$ment ent as #l$e italicied italicied tet enclosed in s$are #racets.]





TABLE O$ CONTENTS 1 INTRODUCTION................................................................ INTRODUCTION.................................................................................................................... .....................................................6 .6 1.1 1.2

Purpose .....................................................................................................................6 Auien!e...................................................................................................................6

2 SYSTEM DESCRIPTION........................................................... DESCRIPTION.................................................................................... ................................. ................ ...........6 ...6 2.1 2.2 2.3 2.4 2.5

"e# $eatures ............................................................................................................6 %nventor# ...................................................................................................................6 nvironment .............................................................................................................6 '#stem Operations ..................................................................................................6 '#stem Ar!ite!ture ................................................................................................6

3 PRODUCT INSTALLAT INSTALLATION........................................ ION.......................................................................................... .......................................................... ........6 6 3.1 3.2 3.3 3.4 3.5 3.6 3.7

$irstTime *sers ......................................................................................................6 A!!ess +ontrols +ontrols.......................................................................................................6 %nstallation .................................................................................................................7 +onfiguration ............................................................................................................7 'tarting te '#stem .................................................................................................7 'topping te '#stem ...............................................................................................7 'uspening te '#stem .........................................................................................7

4 SYSTEM USAGE............................................................... USAGE................................................................................................ .......................................... ................. ............ ....7 7 4.1 4.2

%nstru!tions ...............................................................................................................7 +onventions an rror Messages ........................................................................7

5 SYSTEM MANAGEMENT............................................................. MANAGEMENT............................................................................................. ........................................ ........7 7 5.1 5.2 5.3 5.4 5.5

+ange Management .............................................................................................7 +onfiguration Management ...................................................................................7 ,elease Management .............................................................................................7 'e!urit# Aministration ...........................................................................................8 '#stem Aministration ............................................................................................8

6 SYSTEM MAINTENANCE.......................................................... MAINTENANCE.............................................................................. ............................ ................ .............. ......8 8 7 DATABASE DATABASE ADMINISTRATION ADMINISTRATION AND MAINTENANCE............................ MAINTENANCE.................................... ................ ............. .....8 8 8 BACKUP AND RECOVERY............................................................................................ RECOVERY...................................................................................................8 .......8 9 SERVICE MANAGEMENT........................................................

....8





12 REGULATORY REGULATORY REUIREMENTS...................................................... REUIREMENTS....................................................................................... .................................8 8 13 !AS................................................ !AS........................................................................................................ ............................................................................ ............................ .............. ......8 8

APPEN"I% A OPERATIONS & MAINTENANCE MANUAL APPROVAL .........................9 APPEN"I% B RE$ERENCES .................................................................................................10 APPEN"I% C 'EY TERMS ......................................................................................................11





( 1.1

INTRO"UCTION PURPOSE [nter [nt er in ino orm rmat atio ion n des descr cri# i#in in, , t! t!e e in inte tend nded ed $se o t! t!e e sy syst stem em or pro provi vide de a reerence to "!ere it is stored.]

1.2

AU"IENCE [nter in [nter inorm ormati ation on desc descri# ri#in, in, t!e a$d a$dien ience ce or t!i t!is s doc doc$me $ment nt s$c! as syst system em administrato admini strators rs and operators+ call=center call=center personnel+ etc or provide a reerenc reerence e to "!ere it is stored.]

) 2.1

SYSTEM "E "ESCRIPTION 'EY $EATURES [nter in [nter inorm ormati ation on desc descri# ri#in, in, ey e eat$ at$res res and $n $ncti ctiona onalit lity y o t!e sys system tem or provide a reerence to "!ere it is stored.]

2.2

INVENTORY [nter inorm [nter inormation ation descri#in, descri#in, t!e inventory o system iles and devices or provide a reerence to "!ere it is stored.]

2.3

ENVIRONMENT [nter inormation descri#in, t!e !ard"are+ sot"are+ operational activities+ and ot!er reso$rces needed to perorm actions descri#ed in t!is man$al or provide a reerence to "!ere it is stored.]

2.4

SYSTEM OPERATIONS [nter inormation descri#in, normal system operational $sa,e and activities or provide a reerence to "!ere it is stored.]

2.5

SYSTEM ARCHITECTURE [nter inormation descri#in, t!e system+ net"or+ data#ase+ etc. arc!itect$re or provide a reerence to "!ere it is stored.]

* 3.1

PRO" PRO"UC UCT T INST INSTA ALLAT LLATION ION $IRST+TIME $IRST+TIME USERS [nter speciic instr$ctions t!at may #e $ni$e to irst=time $sers o t!e system or provide a reerence to "!ere it is stored.]







3.3

INSTALLATION [nter [nt er in ino orm rmat atio ion n de descr scri# i#in in, , sp speci ecii ic c in inst stal alla lati tion on pr proce oced$ d$re res s or pr provi ovide de a reerence to "!ere it is stored.]

3.4

CON$I,URATION [nter in [nter inorm ormati ation on desc descri# ri#in, in, de dea$l a$ltt and c$s c$stom tom con coni,$ i,$rat ration ion++ con coni,$ i,$rat ration ion options+ and t!eir associated deinitions or provide a reerence to "!ere it is stored.]

3.5

STARTIN, THE SYSTEM [nter [nt er in ino orm rmat atio ion n des descr cri# i#in in, , !o" to pro prope perl rly y st start art t! t!e e sy syst stem em or pro provi vide de a reerence to "!ere it is stored.]

3.6

STOPPIN, THE SYSTEM [nter [nt er in ino orm rmat atio ion n de descr scri#i i#in, n, !o !o" " to pr prope operl rly y st stop op t! t!e e sys syste tem m or pro provi vide de a reerence to "!ere it is stored.]

3.7

SUSPEN"IN, THE SYSTEM [nter inormation descri#in, !o" to properly s$spend t!e system or provide a reerence to "!ere it is stored.]

4.1

SYSTEM USA,E INSTRUCTIONS [nter inormation descri#in, proper $sa,e o t!e system and system $nctionality or provide a reerence to "!ere it is stored.]

4.2

CONVENTIONS AN" ERROR MESSA,ES [nter inormation descri#in, speciic system r$les+ error messa,es+ and t!eir associated deinition or provide a reerence to "!ere it is stored.]

.

SYSTEM MANA MANA,E ,EM MENT





reerence to "!ere it is stored.] 5.4

SECURITY A"MINISTRATION [nter [nt er in ino orm rmat atio ion n a# a#o$ o$tt !o !o" " to pr prop oper erly ly se sec$ c$re re t! t!e e sy syst stem em.. De Desc scri ri#e #e administrative options+ messa,es+ and t!eir associated deinitions or provide a reerence to "!ere it is stored.]

5.5

SYSTEM A"MINISTRATION [nter [nt er in ino orm rmat atio ion n a# a#o$t o$t !o !o" " to pro prope perl rly y ad admi mini nist ster er t! t!e e sy syst stem em.. De Desc scri ri#e #e administrative options+ messa,es+ and t!eir associated deinitions or provide a reerence to "!ere it is stored.]

/

SYSTEM MAI MAINTENA TENAN NCE [nter [nt er in ino orm rmat atio ion n des descr cri# i#in in, , !o" sy syst stem em ma main inte tena nanc nce e "i "ill ll #e ma mana na,ed ,ed or provide a reerence to "!ere it is stored.]

0

"AT "ATABASE BASE A"MIN A"MINIST ISTRA RATI TION ON AN" AN" MAINTE MAINTENAN NANCE CE [nter inormation descri#in, !o" data#ase administration and maintenance "ill #e mana,ed or provide a reerence to "!ere it is stored.]

1

BAC' BAC'UP UP AN" RECOV ECOVER ERY Y [nter inormation descri#in, !o" system #ac$p and recovery "ill #e mana,ed or provide a reerence to "!ere it is stored. Incl$de Proced$res and se$ences descri#in, #ac$p ro$tines+ media type+ stora,e locations+ and sc!ed$les.]

2

SERVICE MANA MANA,E ,EME MEN NT [nter inormation descri#in, !o" system service "ill #e mana,ed or provide a reerence to "!ere it is stored.]

(3 'EY 'EY CON CONTA TACTS CTS [nter inorm [nter inormation ation descri#in, ey conta contacts cts and associated contact inormation inormation or provide a reerence to "!ere it is stored.]





Appendi5 A A Opertions & Mintenn6e Mn7l Appro!l Te Te une uners rsig igne ne  a!n a!no ole leg ge e te# te# ave ave rev revie iee te te e> Opertions & Mintenn6e Mn7l an agree it te approa! it presents. +anges to tis Opertions & Mintenn6e Mn7l ill 4e !oorinate it an approve 4# te unersigne or teir esignate representatives. [9ist t!e individ$als individ$als "!ose si,nat$res si,nat$res are desired. am amples ples o s$c! individ$als are $ $si sine ness ss 6t 6te" e"ard ard++ Im Impl plem emen enta tati tion on 'a 'ana na,e ,err or Pro Proje ject ct 6p 6pon onso sor. r. -d -dd d additional lines or si,nat$re as necessary. -lt!o$,! si,nat$res are desired+ t!ey are not al"ays re$ired to move or"ard "it! t!e practices o$tlined "it!in t!is doc$ment.] 'ignature5

Date5

Print 6ame5 Title5 ,ole5

'ignature5

Date5

Print 6ame5 Title5 ,ole5

'ignature5 Print 6ame5 Title5 ,ole5

Date5





APPEN"I% B RE$ERENCES [Insert t!e nam [Insert name+ e+ vers version ion n$m n$m#er #er++ desc descrip riptio tion+ n+ and p!ys p!ysica icall loc locati ation on o any doc$ments reerenced in t!is doc$ment. -dd ro"s to t!e ta#le as necessary.] necessary.]

Te folloing ta4le summari8es te o!uments referen!e in tis o!ument. "o67ment Nme nd Version

"es6ription

Lo6tion

[Provide description o t!e doc$ment]

<*59 or Net"or pat! "!ere doc$ment is located>





APPEN"I% C 'EY TERMS [Insert terms [Insert terms and deiniti deinitions ons $sed in t!is doc$ment doc$ment.. -dd ro"s to t!e ta#le as necessary. 7ollo" t!e lin #elo" to or deinitions o project mana,ement terms and acronyms $sed in t!is and ot!er doc$ments.

Te folloing ta4le provies efinitions for terms relevant to tis o!ument. Term

"e8inition

[Insert erm]

[Provide deinition o t!e term $sed in t!is doc$ment.]

[Insert erm]


[Insert erm]


O & M Manual Template

Recommend Documents