E PROJECT

GUIDE Version 6.0

Advisor: Ki u Tr ng Khnh, M.Eng

N I DUNG
Cng ngh , gi i php s d ng Cc b c th c hi n khi th c hi n e-project Document e-Project outline Coding guide

CNG NGH GI I PHP S

Cc cng ngh trong J2EE c th

D NG

JSP, Servlet trnh by/ hi n th (x l ng d ng ty theo e-project s qui nh) v report (s d ng Jasper, BIRT hay jsp/ html thu n) EJB (2.0 hay 3.0) x l business logic (s l ng CMP v Session Bean s qui nh ty theo project) Struts p d ng m hnh x l MVC (c th s d ng Spring Web Flow, ZK Framework, GWT, JSF, Flex, Ruby nhng ton b thnh jsp hay html khng dng zul, mmxl hay cc file c ch ng c a ngn ng ) SQL Server (t 2000 tr ln) cho CSDL + SPx (ty lo i v yu c u)

UML h tr phn tch k JDK h tr JVM n n cho J2EE Cc Web Application Server nh Tomcat, JBoss Report
L trang/ form trnh by d li u d i d ng table (khng c b t k control x l no trn form) D ng c a s browser m i (khng c hyperlink) Ph i truy n tham s (khng lm d ng 1 b ng).

CC B

C TH C HI N

Analysis: khi nh n eproject, t ng nhm th c hi n seminar trnh by v ti trong bu i Analysis (1 bu i 10% i m)

c t h th ng (g m nh ng i t ng g, c n lm g ...) M t cc ch c n ng c n xy d ng cho h th ng (theo yu c u c a project) Cc i t ng qu n l khi th c hi n project (l u tr trn CSDL, th c hi n xy d ng project) Xc nh thnh ph n chnh c a ng d ng (core c a ng d ng) v cc ph n c n thi t cho ng d ng Xc nh cng vi c c a t ng thnh vin trn core chnh (fixing), cc thnh ph n cn l i s chia u cho cc thnh vin Cc thnh vin s hon t t cc thnh ph n core chnh v ph n c n thi t t u n cu i Group leader d ki n tasksheet

K t thc giai o n ny, tasksheet chnh th c ng i th c hi n nhanh chng v ng ti n

c approved

m i

 Design v Documentation (t h n 1,5 tu n):

Th c hi n thi t k cc m hnh

CC B

C TH C HI N (tt)

Usecase diagram Sequence diagram ERD (conceptual v logical), Database, v Validation Form, Report, Validation Tasksheet (group leader th c hi n phn chia cng vi c cho vi c x l)

ng

u trn

Documentation song song trong qu trnh thi t k (member th c hi n ph n no s dump document ph n L u : group leader qui nh r style template khi lm document th c hi n tch h p)

Coding (t i thi u 2 tu n)
Th c hi n coding theo b ng thi t k xy d ng trong 02 b thi cng) Khng c b t k ch nh s a no trong giai o n ny c trn (giai o n

Deadline c a t ng giai o n: xem thng bo v th c hi n ng ti n (th i gian n p document, deadline code ...)

 C 02 lo i ti li u c n n p

CC B

C TH C HI N (tt)

2 quy n document (cho d nhm c 3 hay 5 ng i) n p cho Aptech t i Vi t Nam (hon t t n ph n TaskSheet) B n softcopy n p cho n c n c y 4 ph n n p Aptech Vi t Nam cng v i cc bo co v testing, cng vi c th c hi n ..

Trong giai o n t khi start eProject n th i h n deadline, cc cng vi c c n th c hi n v i n sau

C m i 10 ngy, cc group leader ph i g i status report ( nh km trong eProject assignment) bo co ti n th c hi n cng v i comment v cc groups member c a nhm (cc giai o n ny s c h ng d n c th ) C 3 l n bo co
10 ngy k t ngy start: g i status report km theo review 1, 2 10 ngy k ti p: g i status report km theo document t i tasksheet Ngy deadline: g i status report cu i cng v i document hon ch nh, source code, install guide, user guide (n u c) v feedback form

DOCUMENT OUTLINE Trang ba: th c hi n theo ng m u qui nh Aptech (c 2

t u doc)
Review 1 Review 2 Review 3 Tasksheet Monitoring Report (ch c trong softcopy n p cho n

logo, canh l , ...) s c file m u (table content Chia lm cc ph n

Cc tiu c a t ng ph n (v d : Review 1) ph i c t trn m t trang ring Cc ph n header, footer, kch th c, nh d ng trang th c hi n theo ng m u qui nh Aptech Ton b ti li u c vi t b ng ti ng Anh K t thc m i ph n ph i c ph n k tn xc nh n c a group leader v gio vin h ng d n (c t t c 4 ch k review 1, 2, 3 v tasksheet)

 Th c hi n y cc n i dung trong ph n c u trc chung theo h ng d n bn d i. Ph n k tn xc nh n c a group leader v gio vin h ng d n C u trc chung
Introduction
Nu t ng qut s c n thi t vi t ng d ng ny (tnh hu ng c n xy d ng ng d ng nhu c u xy d ng ng d ng) Hint: Vi t l i ph n Introduction c a Problem Statement trong b n Specification c a n g i cho cc nhm. N u khng c, sinh vin c n xc nh ng d ng c th p d ng trong m hnh th c ti n no vi t n i dung ny

REVIEW 1

Existing Scenario
Nu ln t ng qut yu c u mong mu n c a ng i t hng khi c n vi t ch ng trnh ny Hint: Vi t l i ph n Existing Scenerio c a Problem Statement (n u c). N u khng c, sinh vin ph i d a trn cc c t ch c n ng m t n i dung ny.

 C u trc chung (tt)

REVIEW 1 (tt)

Customer Requirement Specification

Nu chi ti t hay c t cc user requirements Hint: Vi t l i n i dung ph n Proposed Solution c a Problem Statement (n u c). N u khng c, sinh vin ph i c n c trn function requirement cc ch c n ng c yu c u gi ng gi i thnh cc cu gi i ngh a cho ph n ny.

Functional Requirements Specification

Nu cc ch c n ng s c design v implement cho ng d ng ny Hint1: Vi t l i t ng n i dung c m t trong functional requirement k t h p v i customer requirement (Dng cc ph n financial, non-finacial, function requirement). Sau th c hi n phn tch m t c bao nhiu ch c n ng c th c hi n v li t k ra (coi demo trong eProject Document Good) Hint2: trong qu trnh m t ny nn nh m s cho t ng ch c n ng chng ta c th mapping v i cc ch c n ng thi t k v implement trong cc ph n ti p theo (d ki m tra v theo di)

 C u trc chung (tt)

REVIEW 1 (tt)

System requirements Specification

Nu ln c u hnh h th ng, c u hnh ph n c ng, ph n m m yu c u c n p ng khi ch y ng d ng ny Chia r thnh 02 ph n: server v client.

Development Software
Nu tn cc ph n m m chng ta s s d ng trong qu trnh phn tch, thi t k , implement ng d ng Hint: C n nu r phin b n c a t ng ph n m m cng v i SP (n u c) m b o khi deploy ng d ng chng ta s ch y ng WORA

Technology
Nu tn cc cng ngh chng ta p d ng xy d ng ph n m m thi t k m hnh chung c a ng d ng V d : J2EE, ZK framework, Java Web Services

Tip: Nn phn tch v nh m s chi ti t cc yu c u i m cao (xem demoGood)

 Algorithms

REVIEW 2

Nu ra cch gi i quy t (solution description) v cc b c p d ng gi i quy t t ng ch c n ng nu trong ph n functional requirements (mapping v i cc m s ghi trong ph n functional requirements) Cc n i dung m t trong ph n ny s t ng ng v i cc n i dung gi i thch trong sequence diagram v usecase.

Use Case Diagram: Th hi n cc hnh v

Cc actor c a h th ng Ch c n ng c a cc actor M t i t ng trong hnh v Cc thnh ph n ph i c m i lin k t v i nhau (uses includes hay extends)

Sequence Diagram: hnh v v m t (dng form m u)

Cc lu ng x l t ng ng v i Algorithms m t Cc b c tu n t (hint: nn thi t k cng v i form m t y cc control) Cc cch x l exception (hint: v tr l i ph i c xc nh c th t i v tr no dng label v cch gi i quy t) Cc b c thay th alternative (hint: cc lu ng x l t ng ng khi trong 1 solution c 2 cch x l hay gi i quy t. C n xc nh v tr x l t ng t nh exception) C bao nhi u usecase diagram (t t c cc hnh b u d c k c usecase phn r th s c b y nhiu sequence diagram)

REVIEW 2 (tt)

M hnh ERD:
M hnh t ng quan (conceptual) thi t k thch h p v i m t (c cc quan h n:n ch a c th c th relationship) M hnh phn r (logical) thi t k c th ti n t i ci t cc d ng th c th c phn r (ch cn quan h 1:n) Cc th c th c v v i cc thu c tnh (d a trn m hnh logical). L u : v y k cc th c th k c th c th pht sinh.

Ph n k tn xc nh n c a group leader v gio vin h

ng d n

 B ng m t Sequence Diagram
Author Use Case Name Actors Description Requirements Pre-conditions Post-conditions Basic flow H v tn c a Member

REVIEW 2 (tt)

Tn usecase mapping v i m s functional requirement phn tch Tn Actor M t t ng qut ch c n ng c a Sequence hay ch c n ng ny Cc yu c u tr c khi ch c n ng hi n hnh c th c hi n Quy n h n hay vai tr th c hi n ch c n ng ny

Success: output c a ch c n ng khi lm ng Fail: output ch c n ng khi lm sai (exception ) Actor Actions: System Response: - Cc b c th c hi n tu n t c a Actor i -H th ng i ng v i hnh ng c a ng v i hnh ng c a System [exception server s ] L u m t y giao di n hi n th cng tch ch t c a i t ng k -Hnh ng chuy n x l ln server hay c l message box (thng i p, nt nh n ) gi i quy t x l (s d ng [alternative s ] - Hnh ng t ng ng nh s th t n u c nhi u h n 2 tr ng h p) ti p theo bn actor, s p x p theo th t th c hi n, khng song song - nh s th t tu n t Nu cch x l cc tr ng h p alternative nh d u trn dnh cho Actor Nu t ng tr ng h p bo l i do Actor pht sinh. Khng c ghi N/A Cc System i ng Khi khng c ghi N/A Cc System th c hi n x l hay thng bo

Alternative flow Exception flow

REVIEW 2 (tt) V D
Author Use Case Name Actors Description Requirements Pre-conditions Post-conditions Basic flow Nguyen Van A Refresh property Seller Seller wish to refresh the home property that had suspended or nearly expired The property needs to be refresh must suspended or nearly expired Already login into the System as Seller Success: House entrys information will be turned back into active from suspend Fail: Refill information Seller Actions: 1. Seller clicks Refresh button in House properties grid table on Seller Dashboard corresponding with which property needed to be refreshed System Response:

2. System displays Paying Fee page with the following control: - Credit Card No text field. - Fee radio button. - Submit button - Cancel button 3. Seller provide some information required for refreshing process : - Provide credit card no in Credit Card No text field [exception1]

REVIEW 2 (tt) V D
Basic flow Seller Action - Choose level of fee by ticking the Fee radio button. There are three level : + 9.99 $ for 10 days + 18.99 $ for 30 days + 57.99 $ for 60 days 4. Seller clicks Submit button [alternative] System Response:

5. System calls a web service method to check credit card status [exception2] 6. System updates the information and displays Seller Dashboard page with updated information Alternative flow Exceptions Seller Actions: [alternative] Seller clicks Cancel button System Response: System returns to Seller Dashboard page

System Response: Seller Actions: [exception1] Seller provide invalid credit 1. System displayed message to notice seller : The credit card no provided is card no invalid [exception2] The credit card has been 2. System displayed message to notice seller : Your card has been expired or expired or not enough cash not enough cash

REVIEW 3
Thi t k Database
Relationship th c hi n ci t th c t trn DB management (ch p hnh relationship diagram) Ci t c a cc table trnh by theo c u trc (theo form bn d i). i v i cc kha lm kha ngo i ph i ghi r tn b ng v tn field tham chi u (table.field). Cc c t l s number, ngy thng, bit v m t s d ng chu i b t bu c xc nh gi tr Default Value Cc validation trn DB, c th
nh d ng ID c a cc kha chnh thi t k m Rng bu c trn cc kha chnh v kha ngo i (constraints) Cc rng bu c trn cc field c bi t trong CSDL Cc rng bu c lin quan gi a cc b ng (v d : ngy t ha b ng ha n ph i l n h n ngy mua hng b ng nh p hng)
Field Name Data Type Size Null DefaultValue Key Table-Field-Ref

nc a

Description

 Thi t k Database (tt)

REVIEW 3 (tt)

Th hi n cc validation trn CSDL (tt)

Rng bu c trn t ng b ng lin thu c tnh. Rng bu c gi a cc b ng v i nhau. V d : Tables: Invoice Constraints: ngy nh n hng l n h n ngy Name Add Invoice + (ngy nh n hng) Tables: Customer, Order Constraints: m t khch hng c nhi u ha
Add ngy nh n hng (b ng invoice) ph i l n h n ngy m t khch hng c nhi u ha n t hng.

t hng Delete -

Update + (ngy nh n hng)

n
Delete Update + (Customer.CustID existed Order) + (Customer.CustID must exist)

Name Customer

+ (Customer.CustID existed Order) -

Order

+ (Customer.CustID must exist)

REVIEW 3 (tt) GUI Interface (Form)

Trnh by giao di n c a t ng form (ch p hnh) Trnh by t ng lo i control, ph ng th c x l, validation trn t ng control (theo m u bn d i) L u : i v i control l combo box, listbox ph i li t k r rng gi tr n p trong gi tr ch n l a c a control (li t k t ng gi tr ). N u gi tr n p t table trn CSDL, xc nh r tn table v tn field c n p (m t trong Validation) L u : i v i lo i radio button ph i ghi r gi tr ch n l a ci t cng tn cho cc radio button trong nhm (m t trong Validation) M t ch c n ng v cch s d ng form ny (ng i dng s lm c nh ng g v lm nh th no)

Report:
Trnh by giao di n (ch p hnh) Trnh by ngu n k t xu t ra report (table v cc field)

Ph n k tn xc nh n c a group leader v gio vin h

Name Type Validation Event Description

ng d n
Status

 Cc thnh ph n tasksheet ph i c phn u cho cc thnh vin trong nhm (t ng thnh vin u c c t i m ring trong t ng ph n) trnh 01 member lm t ng ph n ring bi t ( i m s th p) C u trc trnh by theo m u (bn d i) Ph n k tn xc nh n c a group leader v gio vin h ng d n

TASK SHEET Trnh by tasksheet theo t ng Review

 Giai o n document nu trn chng ta m t kho ng 10 15 ngy (1,5 n 2 tu n)

G i Status Report l n 1 cng v i cc comment v Review 1 v 2 (cho d chng ta xong n tasksheet) Ti n hnh cc b c chu n b giai o n coding, review v ch nh s a Project In ti li u chu n b n p t i Aptech Vi t Nam Phn chia cng vi c cho giai o n coding

HON T T DOCUMENT

Notes: Ch in ti li u khi c ch p nh n (ti t ki m ti n v th i gian), ti li u s khng c k n u ch a c ch p nh n cho d t i h n n p hay b t k l do no

 Cc thnh vin trong nhm phn chia cng vi c code cho ng u vi c coding d a trn tasksheet phn trong ph n analysis (t p trung coding vo ph n core phn cng i d n ra ph n admin vi c nh gi c ln b o v d a theo ti n trn 70% tnh t core chnh) M i thnh vin ch u trch nhi m coding t bn trong (business logic) n presentation trnh 01 ng i lm m t ph n ring bi t (n u c drop cc thnh vin cn l i v n c th demo b o v ) M i thnh vin coding ph n c a mnh v t testing (b ng testing s nh km ti li u v g i n khi deadlinet) m b o ph n n i dung c a mnh l ng Cu i cng, Group leader cng cc thnh vin ph i h p tch h p thnh th th ng nh t c a ch ng trnh v testing t ng th . L u :
Tr c khi coding, nhm ph i th ng nh t v cch t tn i t ng v ph ng th c x l chung ti n hnh tch h p nhanh chng v trnh xu t hi n l i (group leader ra template chung d dng tch h p) Bo co ti n trong qu trnh coding, th c hi n demo theo l ch, n u khng m b o ng ti n -> drop, khng cb ov

CODING

 Trong qu trnh coding chng ta c n th c hi n cc v n sau:

B sung softcopy n p cho n cc n i dung lin quan n coding theo c u trc h ng d n (slide ti p theo) 10 ngy ti p theo g i status Report cng v i comment v document report n ph n tasksheet (L u : ch thch cho n bi t l b ng m i nh t c ch nh s a so v i status report l n 1) Trong qu trnh coding ph i ch thch comment trong code (d hi u b ng ti ng Anh requirements) xem m u v d bn d i. Notes: Ch thch t t c cc file source, k c t p

CODING (tt)

tin jsp, html. Ch thch trn t ng ph

ng th c, bi n

y nhanh cng vi c hon thnh cng vi c ng th i h n deadline. L u : hi u qu l trn h t khng c n hay v t i u ngh a l p ng m i ch c n ng n yu c u . Ch t i u khi cn th i gian

/** /* Calculate the series of adding many integer number. /* @param /* start starting number integer type. /* end ending number integer type. /* @return /* sum of result in the series of adding long type. /* if start or num is not numeric, return the /* NumberFormatException (msg) with msg /* presents the corresponding message. /* Modifier public */ public long seriesAdd (int start, int end) { long sum = 0; //declare a sum to store the result of adding, then initializing to 0

CODING (tt) COMMENTS V D

/* /* loop from start to end. /* add to sum. */ for (int i = start; i <= end; i ++) { sum += i; // sum = sum + i. adding the sum with i, then assign the result to sum again } /end for return sum; //return the ending result to method } .

 C u trc chung

MONITORING REPORTs

Project Review and Monitoring Report

Nu cc n i dung nh gi Pros v Con trong qu trnh th c hi n coding c a t ng thnh vin. (Kh kh n v ti n ) Nu ln vi c c i ti n hay t i u cch th c v n d ng so v i thi t k . nh gi cc n i dung hon t t v m c (%)

Unit Testing check List

T o sheet nu r t ng ch c n ng v t ng thnh vin code testing m b o ch c n ng th c hi n ng thi t k cng trnh t th i gian (c n c d a trn sequence diagram) N i dung ny nh m m b o cc ch c n ng ng thi t k v th c hi n. Ng i theo di d quan st project lm t nh ng ph n no

Final check List

T o sheet nu r ch c n ng ph n m m h p. (groupleader th c hi n n i dung ny) c test sau khi tch

 Trong qu trnh lm project, cc thnh vin c a nhm s ph i demo theo t ng giai o n l y i m thi t k v final project c php tham gia b o v t i VN (n u khng t cc yu c u ny c th khng cb ov ) Trong qu trnh h ng d n s c email h ng d n theo t ng giai o n m b o cng vi c th c hi n t t. Group leader s l ng i th c hi n phn cng v h tr cng vi c cho thnh vin. Group leader th c hi n bo co tnh tr ng, ti n cng vi c c vi c i u ch nh cng vi c ph h p v reject thnh vin khng th c hi n phn cng v ti n ra. Cc v n khc m c hay xung t gi a cc thnh vin c n thng bo chng ta gi i quy t khng a n i dung ch a gi i quy t n n

NG D N

GOOD LUCK!
HARD WORKING! GOOD OVER NIGHT!