Main
–
Manage recurring maintenance
error
.j
sp
See
U
TILITY FUNCTIONS
Page
52
Recurring
–
Display maintenance item detail
recurringDetail.jsp
Di spl ays data for
sel ected recurri ng
mai ntenance i tem i n one of three modes:
o
Add confi rmati on
o
Modi fy confi rmati on
o
Vi ew
Recurring
.java
See
B
EANS
RecurringDao
.java
See
D
ATA ACCESS OBJECTS
RecurringDetail.java
Gets recurri ngID requested for di spl ay.
Gets di spl ay mode (“vi ew”, “addConfi rm”,
“modConfi rm”) and saves i n Recurri ng bean.
Gets
recurri ng mai ntenance detai l s
for requested
recurri ngID.
Forwards to
recurri ngDetai l
.jsp.
ScriptClean
.java
See
U
TILITY FUNCTIONS
Err
.java
See
T
EMPLATES
–
Display template
category detail
Recurring
–
Manage recurring
maintenance
Recurring
–
List
maintenance
items
ScriptClean
.java
See
U
TILITY FUNCTIONS
Recurring
.java
See
B
EANS
Add confi rmati on
mode
Modi fy confi rmati on buttons
Vi ew mode buttons
ItssHome
.java
Refs to ItssHome constants
.
ItssHome
.java
Refs to ItssHome constants
.
error
.j
sp
See
U
TILITY FUNCTIONS
Page
53
RecurringAddMod.java
See
R
ECURRING
–
M
ANAGE RECURRING
MAINTENANCE
Recurring
–
List maintenance
items
Recurring
–
Add/Modify maintenance
item
Templates
–
Add
p
reparation
Return to…
recurri ng
mai ntenance
Return
to…home
I
tss
Home.java
See
K
EY TO SYMBOLS
E
XAMPLE
:
Process description
.
-------------------------------------------------
-------------------------------------------------
-------------------------------------------------
---------
Logic flow from one process to
anot
her, or result of rendering by a
jsp file.
Example:
-------------------------------------------------
-------------------------------------------------
-------------------------------------------------
---------
Example:
Continuation from a button click in
a previous section.
-----------------------------------------------
--
-------------------------------------------------
-------------------------------------------------
---------
manageRecurring.jsp
See
M
AIN
–
E
ND
S
ESSION
Main
–
Manage recurring maintenance
Add another
Page
54
Recurring
–
Define schedule
recurringSchedule.jsp
Gets worki ng copy of Recurri ng bean from
Recurri ngAddMod.java that wi l l hol d schedul i ng
i nformati on for recurri ng i tem.
Uses javascript and jQuery t
o hi de and di spl ay form
fi el ds for data entry based on the type of schedul e the
user i s defi ni ng.
Changes to schedul i ng parameters tri gger ajax cal ls to
Recurri ngSchedul e.java that updates the Generated
Dates secti on of the form.
Recurring
.java
See
B
EANS
RecurringAddMod.java
(r
e
curri ngBeanStatus = “cancel Schedul e”)
See
R
ECURRING
–
M
ANAGE RECURRING
MAINTENANCE
RecurringAddMod.java
(r
e
curri ngBeanStatus = “saveWork”)
See
R
ECURRING
–
M
ANAGE RECURRING
MAINTENANCE
Save and return
Cancel
RecurringSchedule.java
Gets worki ng copy of Recurri ng bean and
schedul i ng parameters from
recurri ngSchedul e.jsp.
Val i date
s
and edi t
s
data.
Set
s
error i ndi cator and messages i n erro
r
message array i f errors found.
I f no errors found, cal cul ates schedul ed dates
and
update
s
data i n
Recurri ng
bean.
Recurring
.java
See
B
EANS
ItssHome
.java
Refs to I tssHome constants
.
error
.j
sp
See
U
TILITY FUNCTIONS
ItssHome
.java
Refs to ItssHome
constants
.
Err
.java
See
U
TILITY FUNCTIONS
RecurringCalcDates.java
See
U
TILITY FUNCTIONS
Page
55
Utility functions
CheckAuth.java
Checks whether user has authenti cated vi a
NAUAuthZ and saves i ndi cator i n session.
Retri eves exi sti ng UserInfo bean from sessi on, or
creates new one and saves i n sessi on
.
Sets ITSS home url to authenti cated or
unauthenti cated versi on (determi nes whi ch
buttons are di spl ayed).
Gets UserInfo bean (user i nfo [cn, mai l, group
membershi ps] from l dap and svc i nterrupti ons l i st
prefs)
.
ScriptClean.java
Checks val ues for characters that may be used i n
cross
-
site scri pting (XSS) attacks and repl aces them
wi th escaped deci mal equi val ents.
Checks val ues for escaped deci mal cha
racters and
decodes them to thei r text representati ons
.
itssUrl.jsp
Code segment i ncl uded i n jsp pages to get ITSS Home
page url from sessi on.
Email
.java
Sends emai l wi th speci fi ed to, from, subject, body
.
Sends emai l for speci fi c recurring mai ntenance
events.
UserInfo
.java
See
B
EANS
.
LdapDao
.java
See
D
ATA ACCESS OBJECTS
.
error
.jsp
Common page for di spl aying errors
.
Displays one button to allow return to IT Systems
Status home.
NOTE: Due to space considerations, transfer of
control to this page is shown as a method call rather
than a logic flow.
Err
.java
Writes detailed error message to log and either
generic or detailed error message to error web page.
For Ajax functions, w
rites detailed error message to
log
and sends error status to calling web page.
ScriptCl
ean
.java
See
U
TILITY FUNCTIONS
checkAuthentication
.jsp
Code segment included in jsp pages to
c
heck if user is
authenticated. If not, throws JspException.
notAdmin
.jsp
D
isplays message if user has attempted to access
system
admin functions but is not authorized.
Displays one button to allow return to IT Systems
Status home.
RecurringCalcDates
.java
Calculates dates for recurring schedule parameters
provided as input. If no errors found, saves
calculated
dates in Recurring bean.
Processes any individually added or removed dates
in the recurring schedule para
meters and adds them
to or removes them from
to the list of generated
dates.
Recurring
.java
See
B
EANS
ScriptClean
.java
See
U
TILITY FUNCTIONS
Page
56
Data access objects
LdapDao
.java
Gets user i nfo from LDAP and stores i n UserInfo
bean.
Checks recurri ng
mai ntenance noti fi cati on emai l
address for val i di ty against LDAP
i f i t i s a stati c al ias
.
OutageDao
.java
Performs database access for
al l functi ons except
Recurri ng Mai ntenance.
PeopleSearch
.java
In package
edu.nau.i ts.si a.l dap
.
Performs peopl e tree searches i n LDAP
and returns resul ts.
SecureEntries
.java
Object that contai ns LDAP search resul ts
returned by Peopl eSearch.java
.
SecureEntry
.java
Object that contai ns a si ngl e LDAP
search
resul t obtai ned from SecureEntri es.java
.
SecureAttribute
.java
Object that contai ns a si ngl e LDAP
attri bute and rel ated i nformati on
obtai ned from SecureEntry.java
.
UserInfo
.java
See
B
EANS
.
StaticAliasSearch
.java
In package
edu.nau.i ts.si a.l dap
.
Performs
Stati c Al i ases
tree searches i n
LDAP and returns resul ts.
Outages
.java
See
B
EANS
.
Recurring
Dao
.java
Performs database access for
Recurri ng
Mai ntenance functi on
.
Outages
.java
See
B
EANS
.
Recurring
.java
See
B
EANS
.
ItssHome
.java
References to ItssHome
constants
.
ItssHome
.java
References to ItssHome
constants
.
ScriptClean
.java
See
U
TILITY FUNCTIONS
Page
57
Beans
UserInfo
.java
Reposi tory for user i nfo from l dap (cn, ui d, mai l,
group membershi ps) and servi ce i nterrupti ons l i st
names.
Outages
.java
Reposi tory for al l outages currentl y bei ng processed.
Provi des i nformati on rel ated to and deri ved from
currentl y processed outages such as
ti tl e,
descri pti on,
begi n and end dates/ti mes,
esti mated/actual desi gnati on, past/present/future
col or codi ng for di spl ay, counts, sorti ng, etc .
ItssHome
.java
References to ItssHome
constants
.
Recurring.java
Reposi tory for al l
recurri ng mai ntenance i nformati on
currentl y bei ng processed.
Provi des i nformati on rel ated to and deri ved from
currentl y processed
recurri ng mai ntenance i tem
such as
ti tl e, descri pti on, schedul ing i nformati on
, etc
.
ScriptClea
n
.java
See
U
TILITY FUNCTIONS
Outage
Changes.java
Gathers, formats and returns outage detai l
i nformati on for pri nti ng i n
outage noti ce emai l s.
If data has been modi fi ed, i t wi l l be hi ghl i ghted for
html and surrounded wi th "<<" ">>" for text emai l
bodi es
.
ItssHome
.java
References to ItssHome
constants
.
ScriptClean
.java
See
U
TILITY FUNCTIONS
ItssHome
.java
References to ItssHome
constants
.
Page
58
Cron
Jobs
The following cron jobs are run on the middleware machines under user “itss”. Detailed documentation is available in
the project directory in file “i
tssServlets
/
crons
/crontab.txt”.
RecurringExpiryEmail.java
Exami nes the SCHED_END_DATE and
EXPIRY_NOTICE_SENT i n the RECURRING
database tabl e to fi nd recurri ng mai ntenance
defi ni ti ons that wi l l expi re i n 30 days or l ess.
For qual i fyi ng recurring mai ntenance i tems,
sends an emai l
to the NOTIFY_EMAIL address
regardi ng the approachi ng expi ry date and
updates
EXPIRY_NOTICE_SENT.
Runti me error messages are wri tten
to
System.err.
Runti me parameters are recei ved from
crons.properti es fi l e and one command l i ne
argument that speci fi es the
l og fi l e name.
RecurringStatusUpdt.java
Sets statuses to "Compl eted" for al l ITSS
recurri ng mai ntenance outages whose
esti mated end date/ti me has passed, except for
recurri ng i nstances that have an actual begi n or
end date/ti me set. (Setti ng an actual
date/ti me
i s the way a user i ndi cates that the recurri ng
mai ntenance occurred outsi de of the esti mated
wi ndow.
)
Runti me error messages are wri tten
to
System.err.
Runti me parameters are recei ved from
crons.properti es fi l e and one command l i ne
argument that
speci fi es the l og fi l e name.