project final report ms cs manipal university format

Upload: neeraj-singh

Post on 06-Apr-2018

221 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    1/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 1

    Acknowledgement

    I have taken efforts in this project. However, it would not have been possible without

    the kind support and help of many individuals and organizations. I would like to

    extend my sincere thanks to all of them.

    I am highly indebted to Mr. _________ for his guidance and constant supervision as

    well as for providing necessary information regarding the project & also for his

    support in completing the project.

    I would like to express my gratitude towards my parents & member of . for their kind co-operation and encouragement which help me in

    completion of this project.

    I would like to express my special gratitude and thanks to industry persons for giving

    me such attention and time.

    My thanks and appreciations also go to my colleague in developing the project and

    people who have willingly helped me out with their abilities.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    2/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 2

    Contents

    Abstract...................................................................................................................... 6 1. Introduction ......................................................................................................... 71.1 System Reference ....................................................................................... 71.2 Overall Description .............................. .................................................. ....... 71.3 Methodology ................................................................................................ 71.3.1 Sample sub heading ............................................................................. 81.3.2 Sample sub heading ............................................................................. 91.3.3 Sample sub heading ........................................................................... 101.3.4 Six step data migration methodology .................................................. 11

    2. General Description .......................................................................................... 122.1

    Product Functions ...................................................................................... 12

    2.2 Users ......................................................................................................... 132.3 General Constraints ....................................... ............................................ 142.3.1 What our solution is not ...................................................................... 142.3.2 Content Management System ............................................................. 15

    2.3.3 Digital Asset Management System ..................................................... 172.4 Assumptions .............................................................................................. 19

    3. Specific Requirements ...................................................................................... 203.1 Functional Requirements ........................................................................... 21

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    3/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 3

    3.1.1 Functional requirement 1 .................................................................... 213.1.2 Functional requirement 2 .................................................................... 22

    3.2 External Interface Requirements ..................... ........................................... 233.2.1 UserInterfaces ................................................................................... 233.2.2 Hardware Interfaces............................................................................ 233.2.3 Software Interfaces ............................................................................. 233.2.4 Communication Interfaces .................................................................. 23

    3.3 Performance Requirements ....................................................................... 243.3.1 Introduction ......................................................................................... 243.3.2 Performance Requirement - 1 ............................................................. 24

    3.4 Design Constraints .............................. .................................................. ..... 253.4.1 Standards Compliance .............................. .......................................... 253.4.2 Hardware Limitations .......................................................................... 253.4.3 Systems Limitations ....................................... ..................................... 25

    3.5 Attributes ................................................................................................... 26 3.5.1 Availability ........................................................................................... 26 3.5.2 Security/Privacy .................................................................................. 263.5.3 Portability ............................................................................................ 263.5.4 Quality Assurance Requirements .............................. .......................... 263.5.5 Accuracy Requirements ....................................... ............................... 26

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    4/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 4

    3.6 Other Requirements ....................................... ............................................ 273.6.1 Database ............................................................................................ 273.6.2 Related Documentation ...................................................................... 27

    4. Behavioral Description ...................................................................................... 284.1.1 System States ..................................................................................... 284.1.2 Events and Actions ............................................................................. 28

    5. Overall Architecture .......................................................................................... 296. Data Design ...................................................................................................... 306.1 Data Objects or Data Structures ................................................................ 306.2 Files and Database Structures ................................................................... 316.2.1 Logical File Structure .......................................................................... 316.2.2 Logical Record Description ................................................................. 316.2.3 Access Method ................................................................................... 316.2.4 Global Data ......................................................................................... 31

    7. Procedural Design ............................................................................................ 32For each major module or component, you may want to highlight ............................ 327.1 Module - 1 .................................................................................................. 327.1.1 Sub heading........................................................................................ 32

    7.2 Module - 2 .................................................................................................. 358. Interface Design ....................................... ......................................... ................ 36

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    5/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 5

    8.1 User-machine Interfaces ............................................................................ 368.2 Interfaces to external Programs, Systems or Devices ................................ 36

    9. Test Provision ................................................................................................... 379.1 Unit Testing................................................................................................ 379.2 System Testing .......................................................................................... 379.3 Test Guidelines .............................. .................................................. .......... 379.4 Module Testing .......................................................................................... 389.4.1 Module 1 ............................................................................................. 389.4.2 Test Case ........................................................................................... 38Discuss some of the important test cases. Do not add all the test cases. .......... 38

    9.5 Integration Strategy .................................................................................... 3910. Conclusion and scope for future work. ....................................... .................... 4010.1 Conclusion ................................................................................................. 4010.2 Scope for future work ................................................................................. 40

    11. Bibliography .................................................................................................. 4112. Appendices ................................................................................................... 4212.1 Appendix A List of Figures ....................................... ............................... 4212.2 Appendix B ................................................................................................ 43

    13. Literature Survey ........................................................................................... 44

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    6/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 6

    Abstract

    Use the abstract that you have submitted. I have left the figure number below so

    that I can reference them in my list of figures.Appendix A List of Figures

    Figure 1

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    7/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 7

    1. Introduction

    1.1 System Reference

    Describe the complete system into which your project fits in. This section

    should specify the applications/uses of the complete system. (You may have

    added/improvised an already existing system)

    Introduce the system where your project fits in. For instance, if your project

    was on content migration, so I gave reference of the customer and their

    business and why was the need of content migration.

    Figure 2

    1.2 Overall Description

    Specify what your project intends to achieve in the larger perspective of the

    system. Specify in general the requirements of your work and also in general

    solutions provided by your project.

    1.3 Methodology

    This is one of the very important sections where you discuss the project

    methodology. What might be methodology; you can referhttp://goo.gl/k0Irfor

    http://goo.gl/Hr5N3 will give you some idea with reference to one subject. You

    can write similarly for your project.

    Figure 3

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    8/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 8

    1.3.1 Sample sub heading

    Some sample heading from my project. You may add yours similarly.

    Below you see some Important symbol used if you want to highlight

    some points. This can be used consistently throughout your content.

    Is the format for logging of error messages defined?

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    9/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 9

    1.3.2 Sample sub heading

    New heading should start from the new page.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    10/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 10

    1.3.3 Sample sub heading

    I used the following convention (roman) for points. You can use your

    own but need to be consistent.

    I. Start data migration planning early.

    II. Create a separate project plan for migration.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    11/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 11

    1.3.4 Six step data migration methodology

    Use diagrams as much as possible. Also, you should refer the figures

    in your report. For instance, I used the Figure 6, now it has to be

    referred as well somewhere otherwise, it becomes the orphaned

    figure.

    Note the indentation, which is always consistent.

    Figure 4

    1.3.4.1 Sub section

    Since, it is a sub section; this can be in the same page.

    Figure 5

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    12/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 12

    2. General Description

    Here you start describing your project in detail. You can start with goal of your

    project; the model and any other high level things that your reader should know.

    For instance; the examples sub sections given below.

    2.1 Product Functions

    This section mentions the various functions that our solution performs.

    Figure 6

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    13/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 13

    2.2 Users

    List the intended audience/users of your product.

    Figure 7

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    14/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 14

    2.3 General Constraints

    This section specifies the hardware and software framework that our product

    /solution are dependent on & its limitations.

    Specify the hardware and software framework that your product is dependent

    on.

    2.3.1 What our solution is not

    Sometimes, it is good to tell what your solution doesnt offer.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    15/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 15

    2.3.2 Content Management System

    This is one of the products on which our solution is dependent upon,

    so, I have described that system here.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    16/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 16

    2.3.2.1 Interwoven Teamsite CMS

    This is the specific product which was used, so, described

    here.

    Figure 8

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    17/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 17

    2.3.3 Digital Asset Management System

    Digital asset management (DAM) consists of management tasks and

    decisions surrounding the ingestion, annotation, cataloguing, storage,

    retrieval and distribution of digital assets. Digital photographs,

    animations, videos and music exemplify the target-areas of media asset

    management.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    18/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 18

    2.3.3.1 Media Bin

    Media Bin server is anotherInterwoven product that is used to

    manage digital assets such as images.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    19/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 19

    2.4Assumptions

    Narrate whether the solution is absolutely general or some assumptions havebeen made regarding the problem.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    20/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 20

    3. Specific Requirements

    This chapter should specify only the requirements in simpleE

    nglish. Do notinclude solution descriptions.

    Figure 9

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    21/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 21

    3.1 Functional Requirements

    3.1.1 Functional requirement 1

    3.1.1.1 Introduction

    3.1.1.2 Inputs

    3.1.1.3 Processing

    3.1.1.4 Outputs

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    22/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 22

    3.1.2 Functional requirement 2

    3.1.2.1 Introduction

    3.1.2.2 Inputs

    3.1.2.3 Processing

    3.1.2.4 Outputs

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    23/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 23

    3.2 External Interface Requirements

    3.2.1 UserInterfaces

    Even though there is no user interface requirement, mention it so that

    it is not assumed by your reader that you have missed the section.

    3.2.2 Hardware Interfaces

    Not applicable.

    3.2.3

    Software

    Interfaces

    3.2.4 Communication Interfaces

    There is no communication interface requirement.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    24/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 24

    3.3 Performance Requirements

    3.3.1 Introduction

    3.3.2 Performance Requirement - 1

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    25/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 25

    3.4 Design Constraints

    In system design, a design constraint refers to some limitation on the

    conditions under which a system is developed, or on the requirements of the

    system. The design constraint could be on the systems form, fit or function or

    could be in the technology to be used, materials to be incorporated, time

    taken to develop the system, overall budget, and so on. A design constraint is

    normally imposed externally, either by the organization or by some external

    regulation. During system design, it is as important to identify each design

    constraint as it is to elicit requirements since the design constraints place an

    overall boundary around the system design process.

    3.4.1 Standards Compliance

    Not applicable

    3.4.2 Hardware Limitations

    Not applicable

    3.4.3 Systems Limitations

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    26/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 26

    3.5Attributes

    3.5.1 Availability

    Specify duration for which the services of your product be available. Is

    it always available or only when it is executed?

    3.5.2 Security/Privacy

    3.5.3 Portability

    There is no portability related requirement.

    3.5.4 Quality Assurance Requirements

    3.5.5 Accuracy Requirements

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    27/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 27

    3.6 Other Requirements

    3.6.1 Database

    3.6.2 Related Documentation

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    28/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 28

    4. Behavioral Description

    4.1.1 System States

    If your solution is designed to run through well-defined states, show

    the state transition diagram. Each state, inputs to the state and the

    next state should be clearly shown.

    4.1.2 Events and Actions

    Description about events that trigger transition to other states and the

    outputs associated with the actions/states.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    29/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 29

    5. Overall Architecture

    The following figure shows the overall architecture and how the content migration

    solution fits into it.

    Figure 10

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    30/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 30

    6. Data Design

    6.1 Data Objects or Data Structures

    If possible give some example as shown below of the data structure used.

    Good to use some pseudo code. For instance, I used some XML, so have

    provided the sample here.

    Figure 11

    When this file is saved in the data directory, the resulting data record in XML

    format is as follows:

    A new candidate enters the race as of9/23/04.

    Mayoral Race

    Candidate Joins Race

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    31/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 31

    6.2 Files and Database Structures

    If required, add the following subsections. I have removed some of these sub

    sections as per my need whichever was not required.

    6.2.1 Logical File Structure

    6.2.2 Logical Record Description

    6.2.3 Access Method

    6.2.4 Global Data

    Figure 12

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    32/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 32

    7. Procedural Design

    Describe your high level design of your project here. Identify the different modules

    and use some sort of diagrammatic notation to highlight the important component

    of your design.

    For each major module or component, you may want to highlight

    Module Name

    Processing Narrative

    Algorithm Description

    Modules Used

    Comments/Restrictions/Limitations

    7.1 Module - 1

    Figure 13

    7.1.1 Sub heading

    7.1.1.1 Sub-Sub heading

    Good to provide some pseudo code.

    ${packers.db.dri

    verClass}

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    33/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 33

    ${packers.db.url}

    ${packers.db.userName}

    ${packers.db.password}

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    34/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 34

    7.1.1.1.1 ClubSiteMigrationDAO class

    It is good to list down some high level class and its

    responsibilities etc. Or, your sequence diagram, class diagram

    or anything that helps in describing your design.

    Class Name Purpose

    Method Name Purpose

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    35/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 35

    7.2 Module - 2

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    36/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 36

    8. Interface Design

    8.1 User-machine Interfaces

    Important screenshots

    8.2 Interfaces to external Programs, Systems or Devices

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    37/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 37

    9. Test Provision

    9.1 Unit Testing

    9.2 System Testing

    9.3 Test Guidelines

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    38/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 38

    9.4 Module Testing

    For each major module or component, unit testing and the system testing is

    performed.

    9.4.1 Module 1

    9.4.2 Test Case

    Discuss some of the important test cases. Do not add all the test

    cases.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    39/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 39

    9.5 Integration Strategy

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    40/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 40

    10. Conclusion and scope for future work.

    10.1Conclusion

    10.2Scope for future work

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    41/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 41

    11. Bibliography

    References should be through first author and year of publication mentionedin the Bibliography. Example for reference:

    [Hayes98].

    Example for bibliography entry:

    [Hayes98] Hayes, Bircoff (Jan 1998), Simple parallel algorithm for

    BFS of a graph, Information processing letters, 120-125.

    I used the below format for online references

    Joseph R. Hudicka, Dulcian, Inc.. "The Complete Data Migration

    Methodology." Dulcian. 1999 .

    "A Definitive Guide to Automating Content Migration" Kapow Technologies.

    July 2011 < http://www.kapowtech.es/docs/A-Definitive-Guide-Automating-

    Content-Migration.pdf>.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    42/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 42

    12. Appendices

    12.1Appendix A List of Figures

    Describe each figure in simple English.

    Figure 1 The existing website. ....................................... ......................................... .... 6Figure 2...................................................................................................................... 7Figure 3...................................................................................................................... 7Figure 6.................................................................................................................... 11Figure 7.................................................................................................................... 11Figure 8.................................................................................................................... 12Figure 9.................................................................................................................... 13Figure 11.................................................................................................................. 16Figure 13.................................................................................................................. 20Figure 16.................................................................................................................. 29Figure 17.................................................................................................................. 30Figure 18.................................................................................................................. 31Figure 19.................................................................................................................. 32

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    43/44

    Project title Your Name

    Manipal Universal Learning, Bangalore 43

    12.2Appendix B

    You can add some other important steps or screenshots here.

  • 8/3/2019 Project Final Report MS CS Manipal University Format

    44/44

    Project title Your Name

    13. Literature Survey

    Literature Source