sample solutiondesign_doc.docx

8/10/2019 Sample SolutionDesign_Doc.docx

1/11

COMPANY LOGO [email protected]

+00000000000

Solution Design

Sample Contact List

Sample School

Published: 14/10/2014

Version: 1.0


2/11

Solution Design LOGO

Sample Pty Ltd. Commercial In Confidence Page 2

1 Document Control

Change Record

Date Author Version Change Reference

9/09/2010Shafqat

Balouch1.0 Published Version

15/09/10Shafqat

Balouch1.1 Published version

Reviewers

Name Version Approved Position Date

Distribution

Name Position Company


3/11




4/11



2 Table of Contents

1 Document Control ..................................................................................................................... 2

1. Introduction .............................................................................................................................. 5

1.1 Terminology & Abbreviations ............................................................................................ 5

2. Solution Analysis: Current Platform .......................................................................................... 6

2.1 Solution Design Overview Diagram ................................................................................... 9

2.2 Sample User Profile ......................................................................................................... 10

2.3 Contact List View ............................................................................................................. 10

2.4 Sample Contact List Structure .......................................................................................... 11


5/11



1. Introduction

Sample Sample School internal intranet/Internet system is built on top of the Microsoft Office

SharePoint Server 2007 platform. The business uses SharePoint to fulfill and cover various business

processes.

This document focuses on describing the architecture and design that will take place during the

development of CCL (Sample Link Contact List). Of particular focus are low-level components and

communication channels between current systems.

The project aims to see the implementation of tools offering an online solution to provide contact

information for families. This information will be based on a students class groupings within the

School, varying for those in the Junior Schools, Middle and Senior Schools.

Through development, additional functionality will allow all Sample Link Users to be able to view

and manage their own contact information such as phone numbers and home addresses. From this,if they are also a Contact for a Student, they will also be able to become part of the Contact List

Program. Administration requirements would also be implemented to manage the modifications to

personal information by Users for at least the initial period of implementation.

This document excludes licensing requirements and specifics on what licenses are required. It is

targeted towards a technical audience.

1.1

Terminology Abbreviations

Windows SharePoint Services WSS WSS is Microsofts platform for portal and

collaboration solutions. WSS is also a frameworkthat custom applications to make use of unifiedenvironment

Microsoft SharePoint Server 2007 - MOSS MOSS is a product built on top of WSS which

provides enhanced enterprise features to

Businesses or Organizations

Microsoft InfoPath 2007 XML based form solution to facilitate business

needs

Synergetic Sponsor external Data System used to get all the

user information

SampleLink Portal Name


6/11



2. Solution Analysis: Current Platform

CCL (Sample Contact List) involves various components and layers that interact together to support

the underlying business processes. It is a SharePoint solution that comprises of the following high

level components.

InfoPath formsThe solution makes use of InfoPath form to retrieve data from

synergetic and store selected contact information to contact display list. The forms will

reside in SharePoint form Library.

Event Receivers - An event receiver is registered against the lists to modify the

permissions once the contact information is created or modified.

User Profile WebPart This let user view or updates existing profiles in Synergetic

System, also will help user to choose what contact information to display.

Program Subscription Page - Program subscription page (to allow users to opt in/opt

out from the information sharing program)

Contact Display WebPart

This WebPart display all the contacts of the particularGroup, School Section and Class to interact with others in the same section, group or

class.

Contact Information Add or Remove WebPart This let user choose or remove

contact information from contact display.

Contact Approval Workflow - A workflow is executed for forms approval, and also to

send an alert to the Administrator to approve the item. The approval email contains

what fields have been changed by the user so they can perform a manual entry in

Synergetic.

Contact List Terms & Condition Page The page will display legal agreement about

joining the Contact list program and other conditions about how information utilized

under this agreement.

During the development, each of the above will be considered and modeled to operate in MOSS

2007 environment. Diagram on the next page illustrates the major components and lifecycle of the

Solution.

2.1 Technical Design User Profile Page:

An InfoPath Form Services form will be used to display/capture users information in

SharePoint.

User will not have the ability to manually create a new form, or edit an existing form;

however system will automatically decide this for the user based on their information

stored in SampleDB and SharePoint (this will be discussed in detail later in the document).

Form will reside on a SharePoint Forms Library, which will not be accessible to end-users.

Form library will make use Version Control features of SharePoint to track what changes

have been made by user and when.

Form will have the following naming convention: UserProfileForm_. Where

SampleDBID will be a unique key.


7/11



Users SampleDB ID is stored in the Users SharePoint profile under the field Description.

This ID will be used to query users records from SampleDB.

If a Form already exists for the logged in user, that form will be opened in the User Profile

page, if a form doesnt exist then a new form will open, and upon submission will create a

new form for that user. This is to ensure a single version of form exists for one user. InfoPath form will use different view to display the wizard style form requirements as

discussed in the form design.

On load form should pull users information directly from SampleDB if its a new form.

However user should be able to change their profile information which will submit back to

the SharePoint forms library upon submit.

Form needs to maintain a track of which fields a user has changed, suggested solution to

use duplicate fields to maintain data within the form.

The following views needs to be incorporated with-in the InfoPath form:

o Personal Details

o Employment Details

o Additional Information

o Relationship with Sample

o Contact List subscription Terms & Conditions (This information was envisaged in

the Requirements document to be in a separate form; however with discussion with

the customer it has been agreed to merge this information into the User profile

form).

o Contact List subscription Share information (This information was envisaged in

the Requirements document to be in a separate form; however with discussion with

the customer it has been agreed to merge this information into the User profileform).

Once the user submits the form, their application must be approved by an Administrator.

This requires emailing out the information to an Administrator clearly identifying which

fields a user has changed. Once the Administrator makes the changes manually in

SampleDB, he/she will approve the request and the form will be marked as approved.

Until a form has been approved, and is in a pending state, it cannot be resubmitted and

should be locked until approved by an Administrator. The form should disable the Submit

button and let the user know that their previous changes have not been finalized as yet to

submit another request. This can be managed using an edit-able field in InfoPath promoted

to SharePoint. A Boolean field should maintain whether user is part of the program or not. Also, which

piece of information they have allowed to be shared.

Upon submitting the form, user should be taken to a page which says their information has

been forwarded to an Administrator for approval. This page should give the user links to go

back to the main portal screen.

Refer to the requirements document for field metadata types and wireframes.


8/11



A workflow is required for forms approval, and also to send an alert to the Administrator to

approve the item. The approval email should contain what fields have been changed by the

user so they can perform a manual entry in SampleDB.

To exit the program, the user will have to go through the same User Profile form, and

uncheck their subscription on the last view. This should delete users profile from thesystem.

2.2 Technical Design Contact List View:

Contact list view will enable users to see all the contacts who have shared their information.

This view should be an XSLT Data View webpart, and will query the SampleDB database

directly for information. This view will not be accessing data from the Forms Library, as

most up-to-date data exists in SampleDB.

Only users who have opted to be in the program can access this view.

View should perform a query in SampleDB to get all the attached students with a User, and

display it in a list based format. For layout, please refer to the wireframe in therequirements database.

View should be able to drill down into different class groups their student belongs to and

view the information of all the other parents/students attached.


9/11



2.3

Solution Design Overview Diagram

FIGURE 1:SOLUTION DESIGN FLOW

User Login

Link Require User Authentication prior to subscribe the Program

CCL Subscriptionpage

User will go to the subscription page to join the program or unsubscribe theprogram agreed on specific terms & conditions

User Profile Page

User profile page will retrieve user information and display for user toupdate or modify contact information

Contact ListDisplay Page

User will view all or perticular group or section Contact List

ApprovalProcessWorkflow

Approval process will be intiated after each activity and if approval requiredan email notification will be sent to the Approval Group or administrator


10/11



2.4

Sample User Profile

For each user solution begins from a user profile page. This is basic InfoPath WebPart page that

will retrieve user data from synergetic, will be a wizard type which holds different type of

information that is required to subscribe and display contact information.

FIGURE 2:USER PROFILE PAGE

FIGURE 3:EMPLOYMENT DETAIL FORM

FIGURE 4:ADDITIONAL INFORMATION FORM

FIGURE 5:RELATIONSHIP FORM

FIGURE 6: PROGRAM AGREEMENT PAGE

2.5

Contact List View


11/11



2.6

Sample Contact List Structure

FIGURE 7:SAMPLELINK PORTAL STRUCTURE

sample solutiondesign_doc.docx

Documents