SFScience Application Support

cabbagewheatInternet and Web Development

Nov 13, 2013 (3 years and 8 months ago)

145 views








APPLICATION SUPPORT

Sfscience.com


March 2001











2001 The Learning Network, Inc.

11/13/2013


2


TABLE OF CONTENTS



TABLE OF CONTENTS

2

PURPOSE

3

SUMMARY INFORMATION

3

Project Contacts

3

URLS

3

Summarized Architecture Comp
onents

3

Other Sources of Information

4

HIGH LEVEL APPLICATI
ON ARCHITECTURE

5

Components
The supporting documents referred to below are all linked using MSWord. This
package of
documents is designed to be kept togeth
er.

5

Site Administration Tools

6

Admin Tool Submission Approval

6

Writing for Science

6

Kid Publishing

6

National Labs
Java Servlets and JSP.

7

Troubleshooting Checklist

9

Weekly Tasks

9

Monthly Tasks

9

Yearly Tasks

9

Backup and Archiving

10

Recovery Methods

10

APPLICATION SUPPORT
PLANNING

11

Expected Production Volumes

11









2001 The Learning Network, Inc.

11/13/2013


3

PURPOSE

The purpose of this document is to provide a central loca
tion for information required to support the
application. This document will refer to other documents for further detailed or background information.

All referenced documents should be kept in t
he origina
l directory structure to maintai
n t
he links to th
em in
this docu
ment
. Th
e root directory is SFScience Te
chnical

Documentation and this anchor document path
is
SFScience Te
ch
nical

Documentation
/SF
Science

Application Support.doc


SUMMARY INFORMATION

Project Contacts


Name

Role

Comment

Contact Numbers

Renee Choi

Producer


415 615
-
598
2

Mark Gentzel

Application Support

Lead developer supporting
application during
Maintenance Contract

415 615
-
5984


URLS


URLs

Description

Development

dev.sfscience.com

Certification

cert.sfscience.com

Production

www.sfscience.com


Summarized Architecture Components


Component

Description

Development Database
Server

Oracle 8 (8i capable, features not utilized) on Solaris at Learning Network San
Francisco.

Certification and
P
roduction Database
Servers

Oracle 8 on Solaris at Pearson Technology Center.

Development Web
Server

Apache on Linux at Learning Network San Francisco.

Production and
Certification Web
Servers

Apache on Solaris at Pearson Technology Center.









2001 The Learning Network, Inc.

11/13/2013


4


Other Source
s of Information


Source

Description

Programmer

Mark Gentzel: Project Lead Developer

John Borana: Java Developer

Hosting
Environment/Platform
Configuration

Specifications provided by LN Infrastructure:

supporting documents
\
Solaris_Apache_Tomcat_config.txt













2001 The Learning Network, Inc.

11/13/2013


5

HIGH LEVEL APPLICATI
ON ARCHITECTURE

Components

The supporting documents referred to below are all linked using MSWord. This package of
documents is designed to be kept togeth
er.

Site Content and Interactive Feature Generation

Written in Perl. Use CGI technology. Most use XML for content storage.



Chapter Connections and Activities HTML content generation.

Perl Script: genX_1.cgi

See supporting document:
GenX XML Generator


Other documentation for all genX related features:

code specifications
\
Gen_X
\
macro_documentation1.txt

code specifications
\
XML
\
XML Editing Tips from the Developer.doc

code specifications
\
HTML Protocols
\
template_paths.htm

code specifications
\
HTML Protocols
\
xml template conventions.txt




Teacher Tips HTML content generation.

Perl Script: genX_1.cgi

See supporting document:
GenX XML Generator



Writing for Science HTML content and Java Servlet Template generation.

Perl Script: genX_1.cgi

See supporting document:
GenX XML Generator



Question of the Day HTML content generation.

Perl Script: genX_qtd1.cgi

See supporting document:
QtdX XML Generator

Other supporting documents:

code specifications
\
QTD
\
Question of the Day Functional Technical Requirements.doc

code
specifications
\
QTD
\
QTD Technical Specifications Overview.doc

code specifications
\
QTD
\
QTD Use Case 1.doc

code specifications
\
QTD
\
QTD XML Tag Design.doc

code specifications
\
QTD
\
QTD_code_to_spec.doc

code specifications
\
QTD
\
Question of t
he Day Code design draft 1.doc





Black Line Master (BLM) GIF to HTML image map document conversion and generation.

Perl Script: create_blm.cgi

See supporting document:
BLM Generator


CGI Functional
Features

Written in Perl. Use CGI technology.



Question of the Day Presentation

Perl Script: find_qtd.cgi

See supporting document:
Find QTD



Find an Activity

Perl Scripts:

Find by Grade: toc_select_grade.c
gi









2001 The Learning Network, Inc.

11/13/2013


6

Find by Unit: toc_select_unit.cgi

See supporting document:
Find an Activity

Other supporting documents:

code s
pecifications
\
TOC
\
TOC Feature Technical Specifications.doc

code specifications
\
TOC
\
TOC Naming Conventions and Anchor Linking
Specifications.doc



Chapter

Connection Certificate Activity

Perl Script: certificate.cgi

See supporting document:
Certificate CGI Documentation

Site Administration Tools

Perl and CGI



ZIPUSA monthly database zipcode
update

Perl Script: zipusa_updater.cgi

See supporting document:
SFNL ZIPUSA DB Update Document.doc

Other supporting documents:

supporting documents
\
ZONEMAP_CLIMATEMAP_UPDATE_RULES.txt

ZIPUSA specific documents located in ZIPUSA docs
\



Admin Tool New Submission Email Notification

Perl Script: mail_admintool.cgi

See supporting document:
Mail AdminTool Notification Documentation.doc


Java Servlets

Database Connection Pooling

All servlets should use the DatabaseConnection1.class to obtain a connection to the database.
Location: /class
es/com/ln/sfaw/util/

Connection Pooling classes are in /WEB
-
INF/lib/core
-
dbase
-
BLD.9.jar. These are core Learning
Network classes.

See javadoc documentation:
html
\
sfawjavadoc
\
ConnectionPooli
ng
\
index.html

Admin Tool Submission Approval

Java Servlets.

See supporting document:
SF Admin Tool Document.doc

See javadoc documentation:
html
\
sfawjavadoc
\
adminTool
\
index.html

Writing for Science

Java Servlets

See supporting document:
SF WFS and Activity Submissions Document.doc

See javadoc documentatio
n:
html
\
sfawjavadoc
\
WFS
\
index.html



Kid Publishing

Java Servlets and JSP.









2001 The Learning Network, Inc.

11/13/2013


7

JSP location: /webapp/jsp/english/kid_pub and /webapp/jsp/spanish/kid_pub

Classes and source in /WEB
-
INF/classes:

KidPubServle
t.class

KidPubServlet$ActivityMenuSorter.class

See javadoc documentation:
html
\
sfawjavadoc
\
KidPub
\
index.html



National Labs

Java Servlets and JSP.


Registration

See supporting document:
SFNL Data Registration Document.doc

See javadoc documentation:
html
\
sfawjavadoc
\
Registration
\
index.html

Other support documents:

code specifications
\
Registration
\
Database and Lab Progress 2_24.doc


Form Input Validation

See supporting document:
SFNL Data Input Validation Document.doc


Data Input

See supporting document:
SFNL Data Input Document.doc

Other supporting documents:

code specifications
\
Lab Input
\
National Lab Input Specifications.doc


Data Table Display

See supporting Javadoc documention:
SFScience
Documentation/html/sf
awjavadocs/tabledisplay/tree.html


Data Graphical Display

See supporting Javadoc documentation:
SFScience
Documentation/html/sfawjavadocs/chart/tree.html

Also see the Kavachart API: /u/sites/[dev, cert,

www].sfscience.com/api/



Database

The database schema is an ERwin document named DSFS_A1.ER1

Product info:
http://www.cai.com/products/alm/erwin.htm

A few details about some of the database logi
c that is of interest to developers is contained in the
Database Developer Support Document


Database is

manually
purged
of academic year submitted data on August 1

using
a
stored
procedure
. General instructions are in

the

Purging the

Database document:

database
\
Purging the
Database.doc
.

The schema is in this documentation package, but requires ERwin to be installed to o
pen it:

database
\
DSFS_A1.ER1









2001 The Learning Network, Inc.

11/13/2013


8













2001 The Learning Network, Inc.

11/13/2013


9

Application Maintenance Tasks

Troubleshooting

Checklist

For a basic set of troubleshooting guidelines
,

s
ee supporting document:
misc support documents
\
SF
Science
Troubleshooting Checklist.doc


Weekly Tasks

Component

Description

Web Site

During Maintenance period, review bug lists and make modifications keeping
in mind the scheduled monthly re
lease promotion.


Monthly Tasks

Component

Description

Web Site

Promote any modified files in webapp (generally the entire /webapp/
directory is promoted and the SfScience.properties file moved from
/webapp/WEB
-
INF/conf_cert/ into the /webapp/WEB
-
INF/clas
ses/ directory)


Promote cert.sfscience.com to
www.sfscience.com

if modifications warrant
this. An /htdocs/ directory promotion is required if XML content has been
generated or static HTML has been modified. If onl
y Java servlet classes have
been modified, you can promote the /webapp/WEB
-
INF/classes/ directory. If
both Java servlet classes and JSP pages have been modified the /webapp/
directory can be promoted. In either of these cases, the SfScience.properties
file

must be moved from /webapp/WEB
-
INF/conf_prod/ into the
/webapp/WEB
-
INF/classes/ directory. If only JSP pages have been modified
you can promote the /webapp/jsp/ directory only. For simplicity, it is usually
easiest to promote /webapp/ or /htdocs/, or the
full site.

Database

Run the ZIPUSA updater (zipusa_updater.cgi) using the latest ZIPUSA.asc
CSV ASCII file downloaded from ZIPUSA. This file contains any zipcode
splits (new zipcodes).


Yearly Tasks

Component

Description

Database

Purge the database. Run

DELETE_ACADEMICYEAR_DATA

stored
procedure on August 1.











2001 The Learning Network, Inc.

11/13/2013


10



Backup and Archiving


Component

Backup and Archiving

All Application

Regular daily back up schedule during LN maintenance period. To be
handled by PTC after that.

CVS repository on Apollo server.

Project code name “sfsci”. Final local
r数os楴iry g楥i 瑯 卆 慴a捯mpl整楯n of m慩a瑥tan捥 捯n瑲慣琮

䑡瑡b慳a

o敧u污l d慩ay b慣k up sch敤ul攠dur楮g i丠m慩n瑥n慮捥 p敲iod. To b攠
h慮d汥l by mTC 慦瑥t 瑨慴a


Recovery Methods


Component

Recovery Methods

Al
l Application

LN infrastructure recoves from back
-
ups.

CVS repository is accessed by project team members for latest version
recovery. Previous version must be recovered with the help of CVS
administrators.

Database

LN DBAs can recover from back
-
ups.












2001 The Learning Network, Inc.

11/13/2013


11

APPLICATION SUPPORT
PLANNING


Expected Production Volumes


Component

Expected Production Volumes

Database

See
database
\
DSFS_TABS_PROJECTION_12_MONTH.htm