jeanpaulva.files.wordpress.com file · web viewfoster – detailed design [demonstration document]....

FOSTER – DETAILED DESIGN [Demonstration Document] http://jeanpaulva.com

FosterDETAILED DESIGN


DOCUMENT REVIEWSRevision Date Description1.0 Jun 29, 2012 Initial Draft


ContentsIntroduction.................................................................................................................................................5

Purpose...................................................................................................................................................5

Acronyms.................................................................................................................................................6

Audience..................................................................................................................................................6

System Overview.........................................................................................................................................7

Components............................................................................................................................................7

Intranet & Business Impacts....................................................................................................................7

User Characteristics.................................................................................................................................7

Logical Architecture.....................................................................................................................................8

Physical Architecture...................................................................................................................................9

Site Architecture........................................................................................................................................10

Site Collections & Sub Sites.......................................................................................................................11

Site Collection 1: Foster.........................................................................................................................11

Sub Sites....................................................................................................................................................11

Sub Site 1: Home...................................................................................................................................11

Sub Site 2: Applications.........................................................................................................................11

Sub Site 3: Approval...............................................................................................................................11

Sub Site 4: Search..................................................................................................................................11

Custom Content Types..............................................................................................................................12

Site Column 1: Application Status..........................................................................................................12

List Definition 1: Applications................................................................................................................12

List Instances.............................................................................................................................................13

List 1: New Applications.........................................................................................................................13

List 2: Approved Applications................................................................................................................13

List 3: Rejected Applications..................................................................................................................13

List 4: Employment Status.....................................................................................................................13

Screens......................................................................................................................................................14

Screen-01: New Applications.................................................................................................................14

Screen-02: Approved Applications........................................................................................................15


Screen-03: Rejected Applications..........................................................................................................16

Timer Job...................................................................................................................................................17

Client Application......................................................................................................................................18

Get Data................................................................................................................................................18

Post Data...............................................................................................................................................18

Navigation.............................................................................................................................................18

Connect.................................................................................................................................................18

Exit.........................................................................................................................................................18

Configuration.........................................................................................................................................18

Activities....................................................................................................................................................19

New Applications Activities...................................................................................................................19

Approval Application Activities..............................................................................................................20

Timer Job Activities................................................................................................................................21

Roles & Permissions..................................................................................................................................22

Application Security...................................................................................................................................23

Deployment...............................................................................................................................................24

Packages................................................................................................................................................24

Manual Configurations..........................................................................................................................24

Hardware & Software Requirements.........................................................................................................25

Hardware Requirements.......................................................................................................................25

Software Requirements.........................................................................................................................25

References.................................................................................................................................................26


Introduction

PurposeThe document describes the architecture and system design of the FOSTER (Food Stamps Terminal) application.

The goal of the document is to cover the high level system architecture, design, hardware and software requirement for implementing the solution.

The document also contains detailed information on the SharePoint Infrastructures needed like:

Site Collections Sub Sites Content Types Lists Screens


AcronymsThe document is meant for anyone who wanted to understand the system architecture and design. Following are the particularly intended audiences:

Acronym DescriptionFoster Food Stamps TerminalSDK Software Development KitWSP SharePoint Solution Package

AudienceThe document is meant for anyone who wanted to understand the system architecture and design. Following are the particularly intended audiences:

1. Foster Managers2. Foster Developers3. Foster Administrators


System OverviewAs stated in the Requirement Specification, FOSTER application provides a better user interface and automated solutions to address the Food Stamps allocation and management.

ComponentsFollowing are the components involved in the application.

Records Management Metadata Enterprise Search

Intranet & Business ImpactsThe existing intranet sites are not impacted with Foster application. The Foster application will be providing a better management for the existing manual Food Stamps allocation process. It improves the employee productive time usage.

User CharacteristicsFollowing are the users who are authenticated to use the system.

1. Manager2. Clerk

The users are authenticated using Active Directory Domain Services installed in the Intranet. The user has to provide the credentials to login to the system.


Logical ArchitectureFollowing is the Logical Architecture of the Foster application.

The components involved are:

1. User Interface: The user facing components involving site, pages, lists etc.

2. Business Layer: The middle layer which handles the business logic

3. Database: The persistence layer which is actually SharePoint content db.


Physical ArchitectureFollowing is the Physical Architecture of the Foster application.

The SharePoint server contains the following components:

Web Front End Server SharePoint Database Server Content Database Server

The client machines are interacting with the SharePoint server. Domain Controller and Active Directory are other servers in the network. It could reside in the same SharePoint server as well.


Site ArchitectureThe Site Architecture of Foster application is shown below. A new Web Application and Site Collection have to be created.

The Foster Site Collection contains the following sub sites:

1. Home2. Applications3. Approval4. Search


Site Collections & Sub Sites

Following are site collections and sub sites required by the application.

Site Collection 1: Foster

Name: Foster

Type: Site Collection

Sub Sites

Sub Site 1: Home

Name: Home

Type: Site

Sub Site 2: Applications

Name: Applications

Type: Site

Sub Site 3: Approval

Name: Approval

Type: Site

Sub Site 4: Search

Name: Search

Type: Site


Custom Content Types

Following are the custom content types required by the Foster application.

Site Column 1: Application Status

Name: Application Status

Type: Choice

Choices: Started, Approved, Rejected

Default Value: Started

List Definition 1: Applications

Name: Applications


List Instances

Following are the list instances of type Applications.

List 1: New Applications

Name: New Applications

Type: Applications

Parent Site: Applications

List 2: Approved Applications

Name: Approved Applications

Type: Applications

Parent Site: Approval

List 3: Rejected Applications

Name: Rejected Applications

Type: Applications


List 4: Employment Status

Name: Employment Status


Structure following:


ScreensFollowing are the screens involved in the solution.

Screen-01: New ApplicationsFollowing is the view screen for New Applications list.

Following is the entry screen for New Applications. (Use Case Mapping: US-03)


Screen-02: Approved ApplicationsFollowing is the view screen for Approved Applications list.

Following is the entry screen for Rejected Applications. Use Case Mapping: UC-04


Screen-03: Rejected Applications Following is the view screen for Rejected Applications list.

Following is the entry screen for Rejected Applications.


Timer JobThe Employment Status list is managed through the following Timer Job. This timer job fetches new applicant job status from the external database.

Timer Job Name: Employment Status Job

Timer Job Interval: Daily

Description: Reads the New Applicant SSN number and fetches the Job Status from external database. Database is resolved through the connection string specified. Entity Framework is used to connect to the database and query the result.

Entity Structure

Following is the entity structure the Timer Job will be fetching to update the Employment Status list. The whole list is fetched from the database and updated with the list inside Foster. This Employment Status list is in turned used by the Approval workflow.


Client ApplicationThe client application is a .Net 4.0 Windows Forms Application that uses SharePoint Client Object Model API. The client application communicates with SharePoint to get the data and posts it to the Accounting SDK.

Following is the main screen of the Client Application:

Get Data The Get command should fetch the current month total of the Approved Applications from the SharePoint site.

Post Data The Post command should post the total to the Accounting SDK.

NavigationThe Get and Post buttons should be enabled only on having a valid connection with the SharePoint site.

ConnectThe application should provide a button to allow connecting to SharePoint site.

ExitThe application should provide a button to close the application.

Configuration The application includes the configuration file where site url, user name, password are stored.

<appSettings> <add key="site" value="http://foster.server.com"/> <add key="user" value="user"/>


<add key="password" value="password!"/></appSettings>

ActivitiesFollowing are the activities involved in with respect to their operational boundaries.

New Applications ActivitiesFollowing is the activity diagram for the clerk logging in to the system and entering new application details.


Approval Application ActivitiesFollowing is the manger activities in approving a new application. The new application SSN is checked with the Employment Status list inside Foster to Approve or Reject the application.


Timer Job ActivitiesThe Timer Job on the specified interval initiates itself and connects to the external database to update the Employment Status list.


Roles & PermissionsFollowing are the roles and permissions involved in Foster.

Role PermissionsAdministrator Create Web Application, Create Site Collection,Manager Access the sites Home, Applications, Approval and Search. Can execute

the Approval Workflow.Clerk Access the sites Home and Applications. Can Add/Edit/Delete new

applications.


Application SecurityEnsure the application is secured from:

SQL Injection Attacks Cross Site Scripting Attacks


DeploymentDeployment is done through running SharePoint Solution Packages (wsp) files in the server.

PackagesFollowing are the deployment packages determined:

1. Site Content Package2. Workflow Package3. WebParts Package4. Timer Job Package

The Site Content Package should contain the sub sites, list definitions, content types and list instances in their respected position. The Workflow Package contains the Approval Workflow of the project. The WebParts Package contains the Search WebPart associated with the project. The Timer Job Package contains the Employment Status update Timer job associated with the project.

Manual ConfigurationsThe SharePoint Administrator on the client side has to create & configure required Web Application and Site Collection manually.

Users & Permission Configuration WebParts Instantiation


Hardware & Software Requirements

Hardware RequirementsFollowing are the hardware requirements for the proposed system:

CPU 64 bit, four coresRAM 8 GBHard Disk 80 GB of system drive

Software RequirementsFollowing are the software requirements for the proposed system:

Windows Server 2008 R2 SP1Active DirectorySQL Server 2008 R2 64 bitMicrosoft .Net 3.5 SP1Microsoft Chart Controls for .Net 3.5Windows PowerShell 2.0ADO.NET Data Services Update for .Net 3.5Microsoft Filter Pack 2.0Windows Identity Foundation

Following are the roles required in the proposed windows server:

Web Server RoleApplication Server Role


References

Hardware and software requirements (SharePoint Server 2010)

http://technet.microsoft.com/en-us/library/cc262485.aspx

jeanpaulva.files.wordpress.com file · web viewfoster – detailed design [demonstration document]....

Documents