administrative office of the courts technical architecture specifications 4 architecture 4.1

22
TECHNICAL ARCHITECTURE SPECIFICATION <Name of Application> V <X> Category of Application: <A, B, or C> <Hard code date> Administrative Office of the Courts Information Services Division

Upload: others

Post on 22-Aug-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

TECHNICAL ARCHITECTURE

SPECIFICATION

<Name of Application>

V <X> Category of Application: <A, B, or C>

<Hard code date>

Administrative Office of the Courts Information Services Division

Page 2: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

TABLE OF CONTENTS

1 ABOUT THIS DOCUMENT ......................................................................................................... 5 1.1 Document Owner ........................................................................................................... 5

1.1.1 Scope of Documentation ............................................................................... 5 1.2 revision history............................................................................................................... 5

2 INTRODUCTION ........................................................................................................................ 6 2.1 Purpose........................................................................................................................... 6 2.2 Project Overview............................................................................................................ 6 2.3 AOC Technical Architecture Model .............................................................................. 6 2.4 Proposed Environment ................................................................................................... 6

2.4.1 Exceptions to AOC Technical Architecture Model....................................... 6 2.4.2 Rational for Modifications to Model ............................................................ 6

3 REQUIREMENTS ....................................................................................................................... 1 4 <APPLICATION NAME> ARCHITECTURE ............................................................................... 2

4.1 Use cases ........................................................................................................................ 2 4.1.1 Use Case Graphic Overview ........................................................................ 2 4.1.2 Use Case Text Overview............................................................................... 3

4.2 Screen Mockups/WireFrames ........................................................................................ 4 4.3 Changed Screens ............................................................................................................ 5 4.4 Screen Models ................................................................................................................ 5 4.5 Logical Component Architecture ................................................................................... 5

4.5.1 Existing Logical Component Architecture.................................................... 5 4.5.2 Proposed Logical Component ...................................................................... 6

4.6 Component Collaborations............................................................................................. 6 4.7 (Screen) Activity Diagrams............................................................................................ 8 4.8 Service Provision............................................................................................................ 9

4.8.1 Overview of Services .................................................................................... 9 4.8.2 Prequisites for Usinge Service...................................................................... 9 4.8.3 Interface(s) to the Service............................................................................. 9 4.8.4 Error Handling ............................................................................................. 9 4.8.5 Availability.................................................................................................... 9 4.8.6 Performance ................................................................................................. 9 4.8.7 License Requirements ................................................................................... 9

<Name of Application> V <X> Page 2 of 22

Page 3: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

4.8.8 Obligations to Cooperate with othe rUsers of the Service ........................... 9 4.8.9 Security ......................................................................................................... 9 4.8.10 Known Problems........................................................................................... 9 4.8.11 Enterprise Information Services ................................................................... 9

5 DATA ARCHITECTURE........................................................................................................... 11 5.1 Data Requirements ....................................................................................................... 11 5.2 Data Model (ERWin models)....................................................................................... 11

5.2.1 Normalized Data Model ............................................................................. 11 5.2.2 De-normalized Data Model ........................................................................ 11

5.3 Volumes and Sizing ..................................................................................................... 11 5.4 Back-Ups / Reliability / Failover ................................................................................. 11 5.5 Data Transactions and Roll-Back................................................................................. 11 5.6 Database Procedures .................................................................................................... 11 5.7 S/W and H/W To House Data ...................................................................................... 11 5.8 Data Access .................................................................................................................. 11 5.9 Inter Component Data Transport.................................................................................. 11

6 PHYSICAL INFRASTRUCTURE................................................................................................ 13 6.1 Physical Model............................................................................................................. 13

6.1.1 Graphic Overview....................................................................................... 13 6.1.2 Enterprise Integration Overview ................................................................ 13

6.1.2.1 IP Scheme .......................................................................................... 13 6.1.2.2 VP LANs ............................................................................................ 13 6.1.2.3 <Other> ............................................................................................ 13

6.1.3 Workstations ............................................................................................... 13 6.1.4 Workstations ............................................................................................... 13

6.1.4.1 User Workstation............................................................................... 13 6.1.4.2 <Workstations unique to environment>............................................ 13

6.1.5 Servers ........................................................................................................ 14 6.1.5.1 WebServer ......................................................................................... 14 6.1.5.2 Application Server ............................................................................. 14 6.1.5.3 Database Server ................................................................................ 14 6.1.5.4 Reports Server ................................................................................... 14 6.1.5.5 Print Server ....................................................................................... 15 6.1.5.6 Mail Server ........................................................................................ 15 6.1.5.7 Workflow Server ................................................................................ 15

<Name of Application> V <X> Page 3 of 22

Page 4: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

6.1.5.8 Active Directory Server ..................................................................... 15 6.1.5.9 Netegrity Server................................................................................. 15

6.1.6 Enterprise Information Services ................................................................. 16 6.2 Hardware ...................................................................................................................... 16 6.3 Network........................................................................................................................ 16 6.4 Firmware ...................................................................................................................... 16

6.4.1 SAN Storage................................................................................................ 16 6.5 Environmental Security................................................................................................ 16 6.6 Failover ........................................................................................................................ 16 6.7 Disaster Recovery ........................................................................................................ 16 6.8 Environments ............................................................................................................... 16

6.8.1 Development ............................................................................................... 16 6.8.2 Testing ........................................................................................................ 16 6.8.3 Staging........................................................................................................ 16 6.8.4 Production .................................................................................................. 16

<Name of Application> V <X> Page 4 of 22

Page 5: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

1 ABOUT THIS DOCUMENT

This Technical Architecture Specification documents <Name of Application> V <X> architecture.

1.1 DOCUMENT OWNER

The Technical Architect assigned to the application project owns this document. He or she is responsible for completing this document in collaboration with the: • Project manager • Vendor • California Courts Technology Center (CCTC)

At initiation of project, the architect should incorporate known details about the architecture in the appropriate topic.

1.1.1 Scope of Documentation The scope of documentation for which the technical architect is responsible depends on the category of this application, which is referenced on the title page. There are three categories:

A Provides end-user functionality to an existing environment

B Provides end-user functionality and proposes a new (or green field) environment

C Provides infrastructure or services to (multiple) applications of type A and B.

1.2 REVISION HISTORY This section will be used to track changes to the document.

Change # Date Who Description of changes Sections

<Name of Application> V <X> Page 5 of 22

Page 6: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

2 INTRODUCTION

2.1 PURPOSE <Describe the business purpose of this application>

2.2 PROJECT OVERVIEW <If Business Spec is available, cut appropriate information from the document and paste it here. Otherwise, provide a brief overview of the project.>

2.3 AOC TECHNICAL ARCHITECTURE MODEL <Provide a high-level overview of existing environment and reference the ETAG document as necessary

2.4 PROPOSED ENVIRONMENT

Exceptions to AOC Technical Architecture Model 2.4.1

2.4.2 Rational for Modifications to Model

<Name of Application> V <X> Page 6 of 22

Page 7: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> V <X> Administrative Office of the Courts Technical Architecture Specification

3 REQUIREMENTS

<If functional and/or business requirements are available for this application project, reference them here; otherwise gather the requirements and document them here.>

<Version> Page 1 of 22 3/15/2006

Page 8: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

4 <APPLICATION NAME> ARCHITECTURE

4.1 USE CASES

The use cases documented in this section show all the behavior of the proposed system, including the “happy path” functionality as well as representative errors and variants. Human actors show how the user interacts with the system; system actors who how the components interact with each other. <Also included are examples of how multiple sub-use-cases realize an area of functionality.>

Use Case Graphic Overview <The following is an example of a use case model. Replace it with a model that represents this application>

4.1.1

cd Manage Recurring ACH Payments

Manage Recurring ACH Payments

«User Story»Enroll / Modify /

Cancel ACH Recurring Payments

Customer

«User Story»Non Wells Account

«User Story»Select A "To" Wells

Loan Product

«User Story»Select "Set Up" or

"Modify" ACH Payment

«User Story»Wells Account

«User Story»Select "Cancel" ACH

Payment

«Precondition»Customer must hav e

selected Home Mortgage as the

product

«User Story»Mortgage Lag Time after due

date

«User Story»Student Funding

Day of Month

«Precondition»Customer must hav e

selected Student Loan as the product

«User Story»Payment Date

«Precondition»Must be online

customer w ith an Email Address on record.

Must hav e at least one of the follow ing

products in customer's online portfolio: Credit Card, Business Card,

Business Lines, Home Equity, Personal Lines

and Loans, Auto Loans, Mortgage, Student Loan

«User Story»User Changes BOO

View

«Precondition»User is a BOB

Customer w ith more than one BOO View s

«Precondition»Customer must hav e

selected Student Loan or Home

Mortgage as the product

«User Story»Select "From"

Account

«Precondition»Customer must hav e at least one eligible

Wells Account

«precondition»

«Uses»

«Uses»

«uses»

«uses»

«Uses»

«precondition»

«Uses»

«uses»

«precondition»

«extend»

«precondition»

«uses»«uses»

«precondition»

«precondition»«precondition»

«uses»

<Name of Application> V <X> Page 2 of 22

Page 9: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

4.1.2 Use Case Text Overview <The text in the right column provides you with an example of use case text. Replace the text with applicable information.>

Description To change his password, the user must navigate to Siteminder’s “Change Password” screen and

enter his current and new password.

Preconditions The user must have a valid current password

The user must not have been locked-out by a marker in AD

The new password must be valid (user enters something, it is different from current password, has a valid format).

Main Flow 1. To change his password, the user must navigate to Siteminder’s “Change Password” screen. This can be done by

a) Selecting an appropriate link from within the application

b) By selecting the “Change Password” button when presented with the option from Siteminder (e.g. when the user’s password is about to expire)

c) By being forced onto this screen by Siteminder (e.g. on first use of a “temporary password”)

2. The user must enter his current password correctly and then a new password twice.

3. User presses the “Change Password” button

Variant 1 If the user enters the new password in an invalid format, the “change password” page is repainted with the fields cleared and an error message is displayed, e.g. “new password format error: password must be X characters.”

Error 1 User enters incorrect current password …

Post-condition If the password is changed successfully, a confirmation screen displays to tell the user.

<Name of Application> V <X> Page 3 of 22

Page 10: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

4.2 SCREEN MOCKUPS/WIREFRAMES

<Name of Application> V <X> Page 4 of 22

Page 11: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

4.3 CHANGED SCREENS

4.4 SCREEN MODELS cd High-Lev el Screen Interactions

«Screen»Make A Payment (VuDu2)

Make ACH Recurring Payment

«Screen»Site Map - Account Serv ices TAB

Add ACH Recurring Payments

«Screen»Automatic Payment Authorization

Continue

«Screen»Automatic Payment Authorization - Detail Screen

Continue

Back

«Screen»Verify Automatic Payment

Authorize Edit

«Screen»Confirm Automatic Payment

These screens are a high-level introductory example of complex dynamic screens - not al l elements and combinations are shown.

Only the main screens, l inks and "happy path" navigations are shown - error conditions and alternate flows are shown in the more detailed models.

«Screen»Cancel Recurring ACH Verify

«Screen»Cancel Recurring ACH Confirmation

Request Type

YesNo

«Screen»Eligible Product Acct Activ ity

Make Payment

[Cancel]

[Set Up / Modify]

4.5 LOGICAL COMPONENT ARCHITECTURE

Existing Logical Component Architecture

These diagrams show all the components of the existing logical component architecture into which the newly proposed architecture must fit. It will reference the ETAG document as necessary.

4.5.1

<Name of Application> V <X> Page 5 of 22

Page 12: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

<Name of Application> V <X> Page 6 of 22

cd Component Diagram

Content Switch CAFM Application

JBoss ExternalWSInterface

InternalWSInterface

Internal WebServer

ExternalWebServer

Internal User

Apache

Apache

Application Database

Server

Internal Network

External User

Internet

Proposed Logical Component

These diagrams show how the logical component architecture will look once the proposed changes are made.

4.5.2

Example: cd Component Diagram

Content Switch CAFM Application

JBoss

ExternalWSInterface

InternalWSInterface

Internal WebServer

ExternalWebServer

Internal User

Site Minder Policy Server

Identity Minder Server

Apache

Apache

Netegrity Web Agent

Netegrity Web Agent

Application Database

Server

Tech Center AD Server

Internal Network

External User

Internet

4.6 COMPONENT COLLABORATIONS These diagrams show how the logical components collaborate to realize the use cases. A few well-chosen examples are often enough to show how all the functionality will be achieved.

Page 13: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

cd Communication Internal User Sign On

Content Switch

CAFM Application

JBoss

Internal WebServ er

Internal User

Site Minder Policy Serv er

Apache

Netegrity Web Agent

Application Database

Serv er

Tech Center AD Serv er

Internal Network

1: User connects via Private Network

1.1: Private Network connects via Content Switch

1.2: Connect via Internal W/S

2: If user has no session: Send UID/Password 2.1: Authenticate against AD

2.2: Authenticate

3: Pass "sm_user" in header

3.2: Pass back sm_user session ID

3.1: Verify user ID

<Name of Application> V <X> Page 7 of 22

Page 14: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

4.7 (SCREEN) ACTIVITY DIAGRAMS

Based on the use cases and the logical component model: These diagrams show how the logic, performed by individual components, collaborates to realize the use case. The swim-lanes represent logical architectural components and the logical steps required by each are shown within the appropriate swim-lane. Where details of the components are unknown, high-level versions of these diagrams can show just 2 lanes: Actor and System. Since the discrete pieces of logic are linked by control-flow1 arrows, these diagrams show an exact order in which this logic is executed. For projects that don’t primarily focus end-user functionality (category C), the left hand column could just as easily represent systemic actors that are triggered by system events.

Example: ad Standard Logon

Browser WebServer SiteMinder Policy Server Tech Center AD

Internal WebServ er

Apache

Netegrity Web Agent

Log On

Username

Password

Login

User attempts to accessa CAFM screen with noexisting CAFM session

Username andPasswordentered?

Valid Username /Password format?

CredentialsValid fortargetApplication?

"number of consecutiveunsuccessful attempts tologon" > 2

Error Screen - Max Attempts

Exceeded failed attempts. Please contact Helpdesk - 1 800 xxx xxxx

Requested CAFM Page

Password almost expired?

Almost Expired Password

Last 7 days of "Password Validity" period

Change Password

Logon Anyway

Change Password

Old Password

New Password

Change Password

New Password

Error Screen - Password Expired

Password Expired. Please contact Helpdesk - 1 800 xxx xxxx

Password Expired /Locked-out

Temporary Password(set by Helpdesk)?

See "ChangePassword"diagram

[Y]

[N]

{weight=Showerror and clearfields}

[Y]

[N]{weight=Show error and clear fieldsIncrement counter "number ofconsecutive unsuccessful attempts tologon"}

[Y]

[N] {weight=Show error and clear fieldsIncrement counter "number ofconsecutive unsuccessful attempts tologon"}

[N]

[N]

[N]

[Y]

[Y]

{weight=Re-set "number ofconsecutive unsuccessfulattempts to logon" counterto 0}

[N]

[Y]

{weight=Force PasswordChange (lockout thispassword to preventfuture attempts)}

[Y]

1 UML 2.0 <Name of Application> V <X> Page 8 of 22

Page 15: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v> 4.8 SERVICE PROVISION

This section describes how other applications use the service. NOTE: Must be completed if design provides enterprise services (Category C application).

Overview of Services 4.8.1

Prequisites for Usinge Service 4.8.2

Interface(s) to the Service 4.8.3

Error Handling 4.8.4

Availability 4.8.5

Performance 4.8.6

License Requirements 4.8.7

Obligations to Cooperate with othe rUsers of the Service 4.8.8

Security 4.8.9

4.8.10 Known Problems 4.8.11 Enterprise Information Services

This section describes how application uses functionality not housed within the application.

<Name of Application> V <X> Page 9 of 22

Page 16: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

<Name of Application> V <X> Page 10 of 22

Page 17: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

5 DATA ARCHITECTURE

5.1 DATA REQUIREMENTS

This section should be deduced from the business requirements and the earlier parts of this design. It should address what's being stored, why and how it will be used.

5.2 DATA MODEL (ERWIN MODELS)

A standard representation of the data required by the application. This design allows us to add in whatever data types and relations are required.

Normalized Data Model

This model is taken from the previous model but has had some rigorous structure applied through Normalization.

5.2.1

De-normalized Data Model

This is taken from the previous model but has been tuned to handle expected data usage efficiently. Justify each step away from Normalization.

5.2.2

5.3 VOLUMES AND SIZING

Talks to the expected usage of the data. This section is developed in parallel with 5.2.2

5.4 BACK-UPS / RELIABILITY / FAILOVER

Addresses the data administration, the expected performance, recovery and availability of the data.

5.5 DATA TRANSACTIONS AND ROLL-BACK

Highlights any specific data operations that must be coordinated as a group.

5.6 DATABASE PROCEDURES

Operations that should be performed within the database, e.g. report generation.

5.7 S/W AND H/W TO HOUSE DATA

The type of database to meet these requirements.

5.8 DATA ACCESS

How the application will interact with the database.

5.9 INTER COMPONENT DATA TRANSPORT

How the components will pass data between themselves. This might cover: component APIs, XML standards, Business Object data types, etc.

<Name of Application> V <X> Page 11 of 22

Page 18: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

<Name of Application> V <X> Page 12 of 22

Page 19: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

6 PHYSICAL INFRASTRUCTURE

6.1 PHYSICAL MODEL

Graphic Overview 6.1.1

Enterprise Integration Overview 6.1.2

6.1.2.1 IP Scheme

6.1.2.2 VP LANs

6.1.2.3 <Other>

Workstations 6.1.3

Workstations 6.1.4

6.1.4.1 User Workstation Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.4.2 <Workstations unique to environment>

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

<Name of Application> V <X> Page 13 of 22

Page 20: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

Servers <Delete server(s) that are not applicable to this application>

6.1.5

6.1.5.1 WebServer

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.2 Application Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.3 Database Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.4 Reports Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

<Name of Application> V <X> Page 14 of 22

Page 21: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

6.1.5.5 Print Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.6 Mail Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.7 Workflow Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.8 Active Directory Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

6.1.5.9 Netegrity Server

Product Name <Replace with product name>

Hardware requirements <Replace with minimum requirements>

Software requirements <Replace with minimum requirements>

Exception to ETA model? ____ No ____ Yes

DRP reference:

<Paste text from DRP here>

<Name of Application> V <X> Page 15 of 22

Page 22: Administrative Office of the Courts Technical Architecture Specifications  4  ARCHITECTURE 4.1

<Application Name> Administrative Office of the Courts Technical Architecture Specifications <v>

Enterprise Information Services 6.1.6

6.2 HARDWARE

6.3 NETWORK

6.4 FIRMWARE

SAN Storage 6.4.1

6.5 ENVIRONMENTAL SECURITY

6.6 FAILOVER

6.7 DISASTER RECOVERY

6.8 ENVIRONMENTS

Development 6.8.1

Testing 6.8.2

Staging 6.8.3

6.8.4 Production A Appendix

<Name of Application> V <X> Page 16 of 22