Introduction



FosterDETAILED DESIGNDOCUMENT REVIEWSRevisionDateDescription1.0Jun 29, 2012Initial DraftContents TOC \o "1-3" \h \z \u Introduction PAGEREF _Toc329008712 \h 5Purpose PAGEREF _Toc329008713 \h 5Acronyms PAGEREF _Toc329008714 \h 6Audience PAGEREF _Toc329008715 \h 6System Overview PAGEREF _Toc329008716 \h 7Components PAGEREF _Toc329008717 \h 7Intranet & Business Impacts PAGEREF _Toc329008718 \h 7User Characteristics PAGEREF _Toc329008719 \h 7Logical Architecture PAGEREF _Toc329008720 \h 8Physical Architecture PAGEREF _Toc329008721 \h 9Site Architecture PAGEREF _Toc329008722 \h 10Site Collections & Sub Sites PAGEREF _Toc329008723 \h 11Site Collection 1: Foster PAGEREF _Toc329008724 \h 11Sub Sites PAGEREF _Toc329008725 \h 11Sub Site 1: Home PAGEREF _Toc329008726 \h 11Sub Site 2: Applications PAGEREF _Toc329008727 \h 11Sub Site 3: Approval PAGEREF _Toc329008728 \h 11Sub Site 4: Search PAGEREF _Toc329008729 \h 11Custom Content Types PAGEREF _Toc329008730 \h 12Site Column 1: Application Status PAGEREF _Toc329008731 \h 12List Definition 1: Applications PAGEREF _Toc329008732 \h 12List Instances PAGEREF _Toc329008733 \h 13List 1: New Applications PAGEREF _Toc329008734 \h 13List 2: Approved Applications PAGEREF _Toc329008735 \h 13List 3: Rejected Applications PAGEREF _Toc329008736 \h 13List 4: Employment Status PAGEREF _Toc329008737 \h 13Screens PAGEREF _Toc329008738 \h 14Screen-01: New Applications PAGEREF _Toc329008739 \h 14Screen-02: Approved Applications PAGEREF _Toc329008740 \h 15Screen-03: Rejected Applications PAGEREF _Toc329008741 \h 16Timer Job PAGEREF _Toc329008742 \h 17Client Application PAGEREF _Toc329008743 \h 18Get Data PAGEREF _Toc329008744 \h 18Post Data PAGEREF _Toc329008745 \h 18Navigation PAGEREF _Toc329008746 \h 18Connect PAGEREF _Toc329008747 \h 18Exit PAGEREF _Toc329008748 \h 18Configuration PAGEREF _Toc329008749 \h 18Activities PAGEREF _Toc329008750 \h 19New Applications Activities PAGEREF _Toc329008751 \h 19Approval Application Activities PAGEREF _Toc329008752 \h 20Timer Job Activities PAGEREF _Toc329008753 \h 21Roles & Permissions PAGEREF _Toc329008754 \h 22Application Security PAGEREF _Toc329008755 \h 23Deployment PAGEREF _Toc329008756 \h 24Packages PAGEREF _Toc329008757 \h 24Manual Configurations PAGEREF _Toc329008758 \h 24Hardware & Software Requirements PAGEREF _Toc329008759 \h 25Hardware Requirements PAGEREF _Toc329008760 \h 25Software Requirements PAGEREF _Toc329008761 \h 25References PAGEREF _Toc329008762 \h 26IntroductionPurposeThe 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 CollectionsSub SitesContent TypesListsScreens AcronymsThe document is meant for anyone who wanted to understand the system architecture and design. Following are the particularly intended audiences:AcronymDescriptionFosterFood Stamps TerminalSDKSoftware Development KitWSPSharePoint Solution PackageAudienceThe document is meant for anyone who wanted to understand the system architecture and design. Following are the particularly intended audiences:Foster ManagersFoster DevelopersFoster AdministratorsSystem OverviewAs stated in the Requirement Specification, FOSTER application provides a better user interface and automated solutions to address the Food Stamps allocation and ponentsFollowing are the components involved in the application.Records ManagementMetadata Enterprise SearchIntranet & 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.ManagerClerkThe 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:User Interface: The user facing components involving site, pages, lists etc.Business Layer: The middle layer which handles the business logicDatabase: 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 ServerSharePoint Database ServerContent Database ServerThe 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:HomeApplicationsApprovalSearchSite Collections & Sub SitesFollowing are site collections and sub sites required by the application.Site Collection 1: FosterName: FosterType: Site CollectionSub SitesSub Site 1: HomeName: HomeType: SiteSub Site 2: ApplicationsName: ApplicationsType: SiteSub Site 3: ApprovalName: ApprovalType: SiteSub Site 4: SearchName: SearchType: SiteCustom Content TypesFollowing are the custom content types required by the Foster application.Site Column 1: Application StatusName: Application StatusType: ChoiceChoices: Started, Approved, RejectedDefault Value: StartedList Definition 1: ApplicationsName: ApplicationsList InstancesFollowing are the list instances of type Applications.List 1: New ApplicationsName: New ApplicationsType: ApplicationsParent Site: ApplicationsList 2: Approved ApplicationsName: Approved ApplicationsType: ApplicationsParent Site: ApprovalList 3: Rejected ApplicationsName: Rejected ApplicationsType: ApplicationsParent Site: ApprovalList 4: Employment StatusName: Employment StatusParent Site: ApprovalStructure 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-04Screen-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 JobTimer Job Interval: DailyDescription: 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 StructureFollowing 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=""/> <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.RolePermissionsAdministratorCreate Web Application, Create Site Collection, ManagerAccess the sites Home, Applications, Approval and Search. Can execute the Approval Workflow.ClerkAccess the sites Home and Applications. Can Add/Edit/Delete new applications.Application SecurityEnsure the application is secured from:SQL Injection AttacksCross Site Scripting AttacksDeploymentDeployment is done through running SharePoint Solution Packages (wsp) files in the server.PackagesFollowing are the deployment packages determined:Site Content PackageWorkflow PackageWebParts PackageTimer 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 ConfigurationWebParts InstantiationHardware & Software RequirementsHardware RequirementsFollowing are the hardware requirements for the proposed system:CPU64 bit, four coresRAM8 GBHard Disk80 GB of system driveSoftware 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. 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 RoleReferencesHardware and software requirements (SharePoint Server 2010) ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download