CONFMAN Software Design Description Document - METU

66
0 Middle East Technical University Department of Computer Engineering CONFMAN Software Design Description v1.1 Group Hawaii Başak Elif AKGÜN – 1745645 Selin AKİFOĞLU – 1678663 Tolga ATALAY 1678713 Barış ÇAKAR – 1679372 January 18, 2013

Transcript of CONFMAN Software Design Description Document - METU

Page 1: CONFMAN Software Design Description Document - METU

0

Middle East Technical University

Department of Computer Engineering

CONFMAN

Software Design Description v1.1

Group Hawaii

Başak Elif AKGÜN – 1745645

Selin AKİFOĞLU – 1678663

Tolga ATALAY – 1678713

Barış ÇAKAR – 1679372

January 18, 2013

Page 2: CONFMAN Software Design Description Document - METU

1

Preface

This document includes SDD (Software Design Description) documentation for the

Conference Management and Hosting System (CONFMAN). The document is prepared

according to “IEEE Standard for Information Technology – Systems Design – Software Design

Descriptions – IEEE Std 1016 – 2009”.

This Software Design Description provides a description of design details for

“CONFMAN” conference management system.

In the first and second sections an overview of the system and definitions are

provided.

Third section of the document includes conceptual model of the system whereas

fourth section provides design description information content.

In the last section, design description of the Conference Management and Hosting

System is provided through viewpoints.

Page 3: CONFMAN Software Design Description Document - METU

2

Table of Contents

1. Overview .............................................................................................................................................. 5

1.1 Brief summary of the project ........................................................................................................ 5

1.2 Scope ............................................................................................................................................. 5

1.3 Purpose .......................................................................................................................................... 5

1.4 Intended Audience ........................................................................................................................ 6

1.5 References ..................................................................................................................................... 6

2. Definitions ........................................................................................................................................... 6

3. Conceptual Model ............................................................................................................................... 7

3.1 Software design in context ............................................................................................................ 7

3.1.1 Application Overview ............................................................................................................. 7

3.1.2 Technologies Used .................................................................................................................. 7

3.2 Software design descriptions within the life cycle ........................................................................ 8

3.2.1 Influences on SDD preparation .............................................................................................. 8

3.2.2 Influences on software cycle products ................................................................................... 8

3.2.3 Design verification and design role in validation ................................................................... 8

4. Design description information content ............................................................................................. 8

4.1 Introduction ................................................................................................................................... 8

4.2 SDD Identification .......................................................................................................................... 9

4.3 Design stakeholders and their concerns ....................................................................................... 9

4.4 Design views .................................................................................................................................. 9

4.5 Design viewpoints ......................................................................................................................... 9

5. Design Description ............................................................................................................................... 9

5.1 Context Viewpoint ....................................................................................................................... 10

5.2 Logical Viewpoint ........................................................................................................................ 12

5.2.1 Diagram: Class Relationship ................................................................................................. 13

5.2.2 Diagram: User Class .............................................................................................................. 14

5.2.3 Diagram: Conference Chair Class ......................................................................................... 15

5.2.4 Diagram: TPC Chair Class ...................................................................................................... 15

5.2.5 Diagram: PCM Class .............................................................................................................. 16

5.2.6 Diagram: Author Class .......................................................................................................... 16

5.2.7 Diagram: Publication Chair Class .......................................................................................... 17

5.2.8 Diagram: Tourism Agency Chair Class .................................................................................. 17

5.2.9 Diagram: Admin Class ........................................................................................................... 18

Page 4: CONFMAN Software Design Description Document - METU

3

5.2.10 Diagram: Conference Class ................................................................................................. 18

5.2.11 Diagram: Database Class .................................................................................................... 19

5.2.12 Diagram: System Class ........................................................................................................ 19

5.3 Information Viewpoint ................................................................................................................ 20

5.4 Interaction Viewpoint .................................................................................................................. 21

5.4.1 User Sequence Diagrams ...................................................................................................... 21

5.4.1.1 Sign-up Sequence Diagram ................................................................................................ 22

5.4.1.2 Sign-in Sequence Diagram ................................................................................................. 23

5.4.1.3 Sign-out Sequence Diagram .............................................................................................. 24

5.4.1.4 View My Profile Sequence Diagram .................................................................................. 25

5.4.1.5 Edit My Profile Sequence Diagram .................................................................................... 26

5.4.1.6 Send Instant Message Sequence Diagram ........................................................................ 27

5.4.2 Conference Chair Sequence Diagrams ................................................................................. 28

5.4.2.1 Create Conference Sequence Diagram ............................................................................. 28

5.4.2.2 Update Conference Info Sequence Diagram ..................................................................... 29

5.4.2.3 View Conference Info Sequence Diagram ......................................................................... 30

5.4.3 Technical Program Committee (TPC) Chair Sequence Diagrams ......................................... 31

5.4.3.1 Set Conference Details Sequence Diagram ....................................................................... 31

5.4.3.2 Assign Reviewers Sequence Diagram ................................................................................ 32

5.4.3.3 Assign Papers Sequence Diagram ...................................................................................... 33

5.4.3.4 Update Conference Info Sequence Diagram ..................................................................... 34

5.4.3.5 View Conference Info Sequence Diagram ......................................................................... 35

5.4.3.6 Accept Abstract Sequence Diagram .................................................................................. 36

5.4.3.7 Reject Abstract Sequence Diagram ................................................................................... 37

5.4.3.8 Accept Paper Sequence Diagram ...................................................................................... 38

5.4.3.9 Reject Paper Sequence Diagram ....................................................................................... 39

5.4.4 Program Committee Member (PCM) Sequence Diagrams .................................................. 40

5.4.4.1 Select Paper Preferences Sequence Diagram ................................................................... 40

5.4.4.2 View Assigned Papers Sequence Diagram......................................................................... 41

5.4.4.3 Preview Paper Sequence Diagram .................................................................................... 42

5.4.4.4 Download Paper Sequence Diagram ................................................................................. 43

5.4.4.5 Evaluate Paper Sequence Diagram ................................................................................... 44

5.4.5 Author Sequence Diagrams .................................................................................................. 45

5.4.5.1 Upload Abstract Sequence Diagram.................................................................................. 45

Page 5: CONFMAN Software Design Description Document - METU

4

5.4.5.2 Upload Paper Sequence Diagram ...................................................................................... 46

5.4.5.3 View My Papers Sequence Diagram .................................................................................. 47

5.4.5.4 View Results Sequence Diagram ....................................................................................... 48

5.4.5.5 Register to Conference Sequence Diagram ....................................................................... 49

5.4.6 Publication Chair Sequence Diagrams .................................................................................. 50

5.4.6.1 View Accepted Papers Sequence Diagram ........................................................................ 50

5.4.7 Tourism Agency Chair Sequence Diagrams .......................................................................... 51

5.4.7.1 View Participant Info Sequence Diagram .......................................................................... 51

5.4.8 Admin Sequence Diagrams ................................................................................................... 52

5.4.8.1 Fix Reported Problems Sequence Diagram ....................................................................... 52

5.4.8.2 Manage Conference Request Sequence Diagram ............................................................. 53

5.5 Interface Viewpoint ..................................................................................................................... 54

5.5.1 User Interface ....................................................................................................................... 55

5.5.1.1 Conference Chair User Interfaces ..................................................................................... 56

5.5.1.2 TPC Chair User Interfaces .................................................................................................. 57

5.5.1.3 PCM User Interfaces .......................................................................................................... 59

5.5.1.4 Author User Interfaces ...................................................................................................... 61

6. Document Change History ................................................................................................................. 63

Page 6: CONFMAN Software Design Description Document - METU

5

1. Overview

1.1 Brief summary of the project

CONFMAN is a comprehensive conference management system that can host

multiple conferences and their all web based activities. This project provides solutions to the

existing web-based conference management systems’ deficiencies. It combines already

existing features of these systems with new functionalities to satisfy demands and increase

usability.

Some current features such as paper submission, paper referee assignment, referee

evaluations, scheduling and registration will provide the core functionality of our system. We

also offer some additional functionality, which are automatic scheduling of multiple

conferences, multi-language support, storage of reviewers’ statistics (for fair assignment),

multiple role support, OpenID integrability, online payment, tourism agency chair access and

publication chair access.

1.2 Scope

This document will give the design description for the Conference Management and

Hosting System (CONFMAN). A set of design views will be presented in order to specify the

design and development process and provide a basic structure for the project. This

document also gives a clear understanding of how the project will be implemented. The

contents can include some assumptions which will become certain after the implementation

stage.

1.3 Purpose

The purpose of this Software Design Description document is to provide a design and

development description before the code generation phase. This document provides

Page 7: CONFMAN Software Design Description Document - METU

6

verification whether the design meets the requirements stated in SRS[2] (Software

Requirements Specification) document through design viewpoints.

1.4 Intended Audience

As stated in section “1.3 Intended Audience” of “CONFMAN” SRS Document, this

design document is also intended for end users, developers and testers of “CONFMAN” in

order to provide guidance about selection, organization and presentation of design

information.

1.5 References

[1] IEEE. IEEE Std 1016-2009 IEEE Recommended Practice for Software Design Description.

IEEE Computer Society, 2009.

[2] “CONFMAN” Software Specification Requirements (SRS) Document, 2012.

[3] For UML sources: http://www.tutorialspoint.com/uml/index.htm

2. Definitions

IEEE Institute of Electrical and Electronics Engineers

UML Unified Modeling Language

SRS Software Requirements Specification

SDD Software Design Description

IDE Integrated Development Environment

TPC Technical Program Committee

PCM Program Committee Member

Page 8: CONFMAN Software Design Description Document - METU

7

JavaScript Client-side scripting language

MB Megabyte (1024 byte)

PHP Open source general-purpose server-side scripting

language

CSS Cascading Style Sheets

Eclipse Multi-language software development environment

GUI Graphical User Interface

TCP/IP Transmission Control Protocol/Internet Protocol

3. Conceptual Model

Basic terms, concepts and context of SDD will be given in this part.

3.1 Software design in context

3.1.1 Application Overview

The task of the project is to provide a comprehensive conference management

system that can host multiple conferences and their all web based activities. This web-based

system is aimed to help authors, program committee members, publishers and conference

organizers by supplying necessary services.

3.1.2 Technologies Used

This project will be implemented with Java using Eclipse as the IDE, JavaScript and

PHP as scripting languages and CSS as style sheet language.

Page 9: CONFMAN Software Design Description Document - METU

8

3.2 Software design descriptions within the life cycle

3.2.1 Influences on SDD preparation

The SRS documented for “CONFMAN” drives the design process and design

constraints.

3.2.2 Influences on software cycle products

During the preparation phase of SDD and/or during the implementation stage of the

project some requirements may change. Besides, SDD influences test plans and test

documentation of the Conference Management and Hosting System.

3.2.3 Design verification and design role in validation

Design shall be verified and validated to ensure that software product fulfills

specified requirements and serves for intended use.

4. Design description information content

4.1 Introduction

This SDD document is prepared for the design of “CONFMAN”. Throughout the

document identification, diagrams, user views and user viewpoints are provided.

Page 10: CONFMAN Software Design Description Document - METU

9

4.2 SDD Identification

In section “1.Overview” related information can be found.

4.3 Design stakeholders and their concerns

Stakeholders include developers, testers and end users of “CONFMAN”. System

functions that are presented in “3.3.1 Must Have Use Cases” and “3.3.2 May Have Use

Cases” sections of SRS document are the functionalities that serve for end users.

4.4 Design views

UML is used for representing diagrams of views. The information about UML can be

reached from this site: http://tutorialspoint.com/uml/

4.5 Design viewpoints

In this SDD document, context, logical, information, interaction and interface

viewpoints are given.

5. Design Description

In this section, design viewpoints of the project will be defined.

Page 11: CONFMAN Software Design Description Document - METU

10

5.1 Context Viewpoint

“CONFMAN” Software context viewpoint shows the functions provided by the

system. System boundary and the interaction between the system and users are also shown

through this viewpoint1. The context is defined through the interactions between the end

users and the system.

1 Section “3.1 System Environment” of SRS is referenced.

Diagram 1: System Environment

System

CONFMAN Web Page

CONFMAN Database

User

Admin

Page 12: CONFMAN Software Design Description Document - METU

11

Diagram 2: System Functions

System

User

Sign-up

Sign-in

Sign-out

Conference Chair

Create Conference

Update ConferenceInfo

View Conference Info

TPC Chair

Set Conference Details

Assign Reviewers

Assign Papers

Update Conference Info

View Conference info

Accept Paper

Reject Paper

Accept Abstract

Reject Abstract

PCM

Select Paper Preferences

View Assigned Papers

Evaluate Paper

Upload Abstract

Author

Upload Paper

Register to Conference

Publication Chair

View Accepted Papers

View Participant Info

Tourism Agency Chair Admin

Fix Reported Problems

Manage Conference Request

Send Instant Message

View My Profile

Edit My Profile

Preview Paper

Download Paper

View My Papers

View Results

Page 13: CONFMAN Software Design Description Document - METU

12

Besides the system functions shown in the above diagram, system has to handle the

following issues:

1. Scheduling: According to the information provided by Conference Chair and TPC

Chair, the system will schedule the conference to available place and time. In other

words, attributes in “Conference” class (refer to section “5.2.10 Diagram: Conference

Class” for further information) will determine the scheduling process.

2. Multi-language support: System will be available in both Turkish and English

languages. User will be able to select language preference from top-right of user

interface.

3. OpenID: System will be implemented in such a way that a future developer will be

able to integrate OpenID to the system.

5.2 Logical Viewpoint

“CONFMAN” Software contains User, Author, Conference Chair, TPC Chair, PCM,

Publication Chair, Tourism Agency Chair, Admin, Conference and Database classes, which

form the static structure of the system.

Page 14: CONFMAN Software Design Description Document - METU

13

5.2.1 Diagram: Class Relationship

Relationships between the classes are shown.

Diagram 3: Class Relationship

User

-id-cid-password-email-name-surname-title-educationLevel-birthDate-interestedAreas-expertiseAreas-gender-conferences-currentRole-otherRoles

+signIn()+signUp()+signOut()+sendInstantMessage()+viewProfile()+editProfile()

Author

-papers-abstracts-papersResults

+uploadAbstract()+uploadPaper()+viewPapers()+viewResults()+registerToConference()

TPC Chair

+setConferenceDetails()+updateConferenceInfo()+viewConferenceInfo()+assignPapers()+assignReviewers()+acceptPaper()+rejectPaper()+acceptAbstract()+rejectAbstract()

PCM

-assignedPapers-externalReviewers-paperPreferences

+evaluatePaper()+viewAssignedPapers()+selectPaperPreferences()+previewPaper()+downloadPaper()

Conference Chair

+createConference()+updateConferenceInfo()+viewConferenceInfo()

Admin

+fixReportedProblems()+manageConfRequest()

Publication Chair

+viewAcceptedPapers()

Tourism Agency Chair

+viewParticipantInfo()

Conference

-paperList-reviewerList-abstractList-participantList-startDate-endDate-paperLimit-name-location-numberOfRooms-cid

Database

+connect()+disconnect()+testConnection()+executeQuery()+getResult()

System

-systemInfo-conflictsAndComplaints

+schedule()+check()+sendMail()+calculateStatistics()+assignPapersAutomatically()

1

1

0..*

1

0..*

1

0..*

0..*

0..*

1

Page 15: CONFMAN Software Design Description Document - METU

14

5.2.2 Diagram: User Class

“User” is the superclass of “Author”, “TPC Chair”, “PCM”, “Conference Chair”,

“Admin”, “Publication Chair” and “Tourism Agency Chair” classes.

“User” class holds the user information (id, cid; i.e. conference id, password, e-mail,

name, surname, title, educationLevel, birthDate, interestedAreas, expertiseAreas, gender,

conferences, currentRole and otherRoles) of the end users.

“User” class also contains sign-in, sign-out, sign-up, send instant message, view

profile and edit profile use cases (referring to sections “3.3.2.1 User Use Cases” and “3.3.3.1

User Use Cases” of SRS) as methods.

Diagram 4: User Class

User

-id-cid-password-email-name-surname-title-educationLevel-birthDate-interestedAreas-expertiseAreas-gender-conferences-currentRole-otherRoles

+signIn()+signUp()+signOut()+sendInstantMessage()+viewProfile()+editProfile()

Page 16: CONFMAN Software Design Description Document - METU

15

5.2.3 Diagram: Conference Chair Class

“Conference Chair” is a sub-class of “User” class, which is designed to serve for the

conference chair of a conference.

“Conference Chair” class contains create conference, view conference info and

update conference info uses cases (referring to sections “3.3.2.2 Conference Chair Use

Cases” of SRS) as methods.

5.2.4 Diagram: TPC Chair Class

“TPC Chair” is a derived class of “User” superclass. “TPC Chair” class is used as a

specialized class for “Technical Program Committee Chair” user.

“TPC Chair” class contains set conference details, update conference info, view

conference info, assign papers, assign reviewers, accept paper, reject paper, accept abstract

and reject abstract use cases (referring to sections “3.3.2.3 Technical Program Committee

(TPC) Chair Use Cases” of SRS) as methods.

Diagram 5: Conference Chair

Class

Conference Chair

+createConference()+updateConferenceInfo()+viewConferenceInfo()

TPC Chair

+setConferenceDetails()+updateConferenceInfo()+viewConferenceInfo()+assignPapers()+assignReviewers()+acceptPaper()+rejectPaper()+acceptAbstract()+rejectAbstract()

Diagram 6: TPC Chair Class

Page 17: CONFMAN Software Design Description Document - METU

16

5.2.5 Diagram: PCM Class

“PCM” is a sub-class class of “User” superclass. “PCM” class is used as a specialized

class for “Program Committee Member” user.

“PCM” class holds the additional information about assigned papers, external

reviewers and paper preferences.

“PCM” class also contains evaluate paper, view assigned papers, preview paper,

download paper and select paper preferences use cases (referring to sections “3.3.2.4

Program Committee Member (PCM) Use Cases” of SRS) as methods.

5.2.6 Diagram: Author Class

“Author” is a derived class of “User” superclass. “Author” class is used as a

specialized class for “author” users.

“Author” class holds authors’ papers and abstracts as extra information. It also

contains upload abstract, upload paper, view papers, view results and register to conference

use cases (referring to sections “3.3.2.5 Author Use Cases” of SRS) as specific methods.

Diagram 7: PCM Class

PCM

-assignedPapers-externalReviewers-paperPreferences

+evaluatePaper()+viewAssignedPapers()+selectPaperPreferences()+previewPaper()+downloadPaper()

Page 18: CONFMAN Software Design Description Document - METU

17

Publication Chair

+viewAcceptedPapers()

Tourism Agency Chair

+viewParticipantInfo()

5.2.7 Diagram: Publication Chair Class

“Publication Chair” is a sub-class of “User” superclass. “Publication Chair” class is

used as a specialized class for “publication chair” user.

“Publication Chair” class contains view accepted papers use case (referring to

sections “3.3.2.6 Publication Chair Use Cases” of SRS) as its distinctive method.

5.2.8 Diagram: Tourism Agency Chair Class

“Tourism Agency Chair” is a derived class of “User” superclass. “Tourism Agency

Chair” class is used as a specialized class for “tourism agency chair” user.

“Tourism Agency Chair” class contains view participant info use case (referring to

sections “3.3.2.7 Tourism Agency Use Cases” of SRS) as its specific method.

Diagram 8: Author Class

Diagram 9: Publication Chair Class

Diagram 10: Tourism Agency Chair Class

Author

-papers-abstracts-papersResults

+uploadAbstract()+uploadPaper()+viewPapers()+viewResults()+registerToConference()

Page 19: CONFMAN Software Design Description Document - METU

18

5.2.9 Diagram: Admin Class

“Admin” is a derived class of “User” superclass. “Admin” class is used as a specialized

class for “admin” users.

“Admin” class contains fix reported problems and manage conference request use

cases (referring to sections “3.3.2.8 Admin Use Cases” of SRS) as its distinctive methods.

5.2.10 Diagram: Conference Class

“Conference” is a class for holding information about each conference.

“Conference” class contains a number of attributes (paperList (list for accepted

papers), reviewerList (list for reviewers assigned to the conference), abstractList (list for

accepted abstracts), participantList (list for participants attending to the conference),

startDate, endDate, paperLimit (maximum number of papers that can be accepted to that

conference), name, location, numberOfRooms (rooms available in conference’s location),

cid; i.e. conference id) for conference information.

Diagram 11: Admin Class

Admin

+fixReportedProblems()+manageConfRequest()

Page 20: CONFMAN Software Design Description Document - METU

19

Database

+connect()+disconnect()+testConnection()+executeQuery()+getResult()

5.2.11 Diagram: Database Class

“Database” is a class for holding methods about accessing to the database, which

holds all the information related to the system, and executing queries and getting their

results.

5.2.12 Diagram: System Class

“System” is a class for methods that will automatically handle system related issues

like checking for confirmation, scheduling conferences, sending e-mails to users during “sign-

up” phase, calculating some statistical information about program committee members and

assigning papers to reviewers automatically.

Conference

-paperList-reviewerList-abstractList-participantList-startDate-endDate-paperLimit-name-location-numberOfRooms-cid

Diagram 12: Conference Class

Diagram 13: Database Class

Page 21: CONFMAN Software Design Description Document - METU

20

“System” class contains attributes, systemInfo, for holding all users’ and conferences’

information and conflictsAndComplaints, for holding conflicts in the system and complaints

by the users.

“System” class contains check, schedule, sendMail, calculateStatistics and

assignPapersAutomatically functions as methods.

5.3 Information Viewpoint

“CONFMAN” has a database which holds the persistent data content about all the

information related to the system. End users (except admin) interact with this database

indirectly via user interface. Admin user interacts with this database directly.

System

-systemInfo-conflictsAndComplaints

+schedule()+check()+sendMail()+calculateStatistics()+assignPapersAutomatically()

Diagram 14: System Class

Page 22: CONFMAN Software Design Description Document - METU

21

5.4 Interaction Viewpoint

Interaction viewpoint is provided through sequence diagrams, to explain the main

functionalities of the Conference Management and Hosting System.

5.4.1 User Sequence Diagrams

This section refers to sections “3.3.2.1 User Use Cases ” and “3.3.3.1 User Use Cases”

of CONFMAN SRS document.

Conference Chair

TPC Chair

PCM

Author

Publication Chair

Tourism Agency Chair

Conference Chair User Interface

TPC Chair User Interface

PCM User Interface

Author User Interface

Publication Chair User Interface

Tourism Agency Chair User Interface

Database

Admin

Diagram 15: Information Viewpoint

Page 23: CONFMAN Software Design Description Document - METU

22

5.4.1.1 Sign-up Sequence Diagram

This section refers to “3.3.2.1.1 Use Case: Sign-up” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 16: Sign-up Sequence Diagram

User Database System<<UI*>>

1 : signUp()

2 : userInformation

3 : userEmail

4 : sendMail()

5 : activate

Page 24: CONFMAN Software Design Description Document - METU

23

5.4.1.2 Sign-in Sequence Diagram

This section refers to “3.3.2.1.2 Use Case: Sign-in” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 17: Sign-in Sequence Diagram

opt

[invalid][invalid]

opt

[valid][valid]

User <<UI*>> Database

1 : signIn()2 : username, password

3 : "invalid username or password"

4 : "valid username and password"

Page 25: CONFMAN Software Design Description Document - METU

24

5.4.1.3 Sign-out Sequence Diagram

This section refers to “3.3.2.1.3 Use Case: Sign-out” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

opt

[Yes][Yes]

opt

[No][No]

User <<UI*>>

1 : signOut()

2 : ask for confirmation

3 : yes

4 : "successfully logged out"

5 : no

6 : redirection

Diagram 18: Sign-out Sequence Diagram

Page 26: CONFMAN Software Design Description Document - METU

25

5.4.1.4 View My Profile Sequence Diagram

This section refers to “3.3.2.1.4 Use Case: View My Profile” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 19: View My Profile Sequence Diagram

User <<UI*>> Database

1 : viewProfile()

2 : send request

3 : profile information

Page 27: CONFMAN Software Design Description Document - METU

26

5.4.1.5 Edit My Profile Sequence Diagram

This section refers to “3.3.2.1.5 Use Case: Edit My Profile” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

User <<UI*>> Database

1 : viewProfile()

2 : send request

3 : profile information4 : editProfile()

5 : fill desired fields

6 : press Save button

7 : editted information

Diagram 20: Edit My Profile Sequence Diagram

Page 28: CONFMAN Software Design Description Document - METU

27

5.4.1.6 Send Instant Message Sequence Diagram

This section refers to “3.3.3.1.1 Use Case: Send Instant Message” (May Have Use

Case) section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 21: Send Instant Message Sequence

Diagram

User1 <<UI*>> User2

1 : sendInstantMessage()

2 : fill fields

3 : press Send button4 : message sent

Page 29: CONFMAN Software Design Description Document - METU

28

5.4.2 Conference Chair Sequence Diagrams

This section refers to sections “3.3.2.2 Conference Chair Use Cases ” of CONFMAN

SRS document.

5.4.2.1 Create Conference Sequence Diagram

This section refers to “3.3.2.2.1 Use Case: Create Conference” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

opt

[confirm][confirm]

opt

[not confirm][not confirm]

Conference Chair <<UI*>> SystemConference Database

1 : createConference()2 : conference information

3 : send conference information

4 : send conference information

5 : "not created"

Diagram 22: Create Conference Sequence Diagram

Page 30: CONFMAN Software Design Description Document - METU

29

5.4.2.2 Update Conference Info Sequence Diagram

This section refers to “3.3.2.2.2 Use Case: Update Conference Info” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 23: Update Conference Info Sequence Diagram

opt

[confirm][confirm]

opt

[not confirm][not confirm]

Conference Chair <<UI*>> Conference Database System

1 : updateConferenceInfo()

2 : related information

3 : updated information

4 : updated information

5 : "not updated"

Page 31: CONFMAN Software Design Description Document - METU

30

5.4.2.3 View Conference Info Sequence Diagram

This section refers to “3.3.2.2.3 Use Case: View Conference Info” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 24: View Conference Info Sequence Diagram

Conference Chair Conference<<UI*>>

1 : select conference from menu

2 : viewConferenceInfo()

3 : conference name

4 : conference info is viewed

Page 32: CONFMAN Software Design Description Document - METU

31

5.4.3 Technical Program Committee (TPC) Chair Sequence Diagrams

This section refers to sections “3.3.2.3 Technical Program Committee (TPC) Chair Use

Cases” of CONFMAN SRS document.

5.4.3.1 Set Conference Details Sequence Diagram

This section refers to “3.3.2.3.1 Use Case: Set Conference Details” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> Conference Database

1 : select conference from menu

2 : setConferenceDetails()3 : related information

4 : related information

5 : redirected

Diagram 25: Set Conference Details Sequence Diagram

Page 33: CONFMAN Software Design Description Document - METU

32

5.4.3.2 Assign Reviewers Sequence Diagram

This section refers to “3.3.2.3.2 Use Case: Assign Reviewers” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> Database SystemConference PCM

1 : select conference from menu

2 : assignReviewers()3 : send request

4 : list of reviewers5 : select checkboxes

6 : press assign button7 : assigned reviewers

8 : assigned reviewers

9 : sendMail()

10 : redirected

Diagram 26: Assign Reviewers Sequence Diagram

Page 34: CONFMAN Software Design Description Document - METU

33

5.4.3.3 Assign Papers Sequence Diagram

This section refers to “3.3.2.3.3 Use Case: Assign Papers” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

opt

[Manual]

loop

[Manual]

looploop

opt

[Automatic][Automatic]

TPC Chair <<UI*>> Conference PCM System

1 : select conference

2 : assignPapers()

3 : ask for method

4 : list of assigned reviewers

5 : ask for selection

6 : select paper from menu

7 : press Add button

8 : reviewer-paper list

9 : press Assign button10 : assigned papers

11 : assigned paper

12 : sendMail()

13 : list of assigned reviewers

14 : assignPapersAutomatically()15 : press Assign button

16 : sendMail()

Diagram 27: Assign Papers Sequence Diagram

Page 35: CONFMAN Software Design Description Document - METU

34

5.4.3.4 Update Conference Info Sequence Diagram

This section refers to “3.3.2.3.4 Use Case: Update Conference Info” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> Conference

1 : select conference from menu

2 : updateConferenceInfo()

3 : related information

4 : press Save button

5 : redirected

Diagram 28: Update Conference Info Sequence

Diagram

Page 36: CONFMAN Software Design Description Document - METU

35

5.4.3.5 View Conference Info Sequence Diagram

This section refers to “3.3.2.3.5 Use Case: View Conference Info” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> Conference

1 : select conference from menu

2 : viewConferenceInfo()

3 : related information

Diagram 29: View Conference Info Sequence Diagram

Page 37: CONFMAN Software Design Description Document - METU

36

5.4.3.6 Accept Abstract Sequence Diagram

This section refers to “3.3.2.3.6 Use Case: Accept Abstract” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 30: Accept Abstract Sequence Diagram

TPC Chair <<UI*>> Conference System PCMDatabase

1 : select conference from menu

2 : press Abstracts button

3 : list of abstracts

4 : acceptAbstract()5 : accepted abstract

6 : accepted abstract7 : sendMail()

Page 38: CONFMAN Software Design Description Document - METU

37

5.4.3.7 Reject Abstract Sequence Diagram

This section refers to “3.3.2.3.7 Use Case: Reject Abstract” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> System PCMDatabase

1 : select conference from menu

2 : press Abstracts button

3 : abstractList

4 : rejectAbstract()

5 : rejected abstract6 : sendMail()

Diagram 31: Reject Abstract Sequence Diagram

Page 39: CONFMAN Software Design Description Document - METU

38

5.4.3.8 Accept Paper Sequence Diagram

This section refers to “3.3.2.3.8 Use Case: Accept Paper” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> Conference System PCMDatabase

1 : select conference from menu

2 : press Papers button

3 : list of papers

4 : acceptPaper()5 : accepted paper

6 : accepted paper7 : sendMail()

Diagram 32: Accept Paper Sequence Diagram

Page 40: CONFMAN Software Design Description Document - METU

39

5.4.3.9 Reject Paper Sequence Diagram

This section refers to “3.3.2.3.9 Use Case: Reject Paper” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

TPC Chair <<UI*>> System PCMDatabase

1 : select conference from menu

2 : press Papers button

3 : list of papers

4 : rejectPaper()

5 : rejected paper6 : sendMail()

Diagram 33: Reject Paper Sequence Diagram

Page 41: CONFMAN Software Design Description Document - METU

40

5.4.4 Program Committee Member (PCM) Sequence Diagrams

This section refers to sections “3.3.2.4 Program Committee Member (PCM) Use

Cases” of CONFMAN SRS document.

5.4.4.1 Select Paper Preferences Sequence Diagram

This section refers to “3.3.2.4.1 Use Case: Select Paper Preferences” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 34: Select Paper Preferences Sequence Diagram

loop

PCM <<UI*>> Conference

1 : select conference from menu

2 : selectPaperPreferences()

3 : paperList

4 : paper list as drop-down menu

5 : select paper from menu

6 : press Add button

7 : press Save button

8 : paperPreferences saved

Page 42: CONFMAN Software Design Description Document - METU

41

5.4.4.2 View Assigned Papers Sequence Diagram

This section refers to “3.3.2.4.2 Use Case: View Assigned Papers” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 35: View Assigned Papers Sequence Diagram

PCM <<UI*>>

1 : select conference from menu

2 : viewAssignedPapers()

3 : request

4 : assigned papers

Page 43: CONFMAN Software Design Description Document - METU

42

5.4.4.3 Preview Paper Sequence Diagram

This section refers to “3.3.2.4.3 Use Case: Preview Paper” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

PCM <<UI*>> Database

1 : select conference from menu

2 : viewAssignedPapers()

3 : send request

4 : assignedPapers

5 : previewPaper()6 : send request

7 : content of paper

Diagram 36: Preview Paper Sequence Diagram

Page 44: CONFMAN Software Design Description Document - METU

43

5.4.4.4 Download Paper Sequence Diagram

This section refers to “3.3.2.4.4 Use Case: Download Paper” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

PCM <<UI*>> Database

1 : select conference from menu

2 : viewAssignedPapers()

3 : send request

4 : assignedPapers

5 : downloadPaper()6 : send request

7 : paper downloaded

Diagram 37: Download Paper Sequence Diagram

Page 45: CONFMAN Software Design Description Document - METU

44

5.4.4.5 Evaluate Paper Sequence Diagram

This section refers to “3.3.2.4.5 Use Case: Evaluate Paper” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

PCM <<UI*>> System TPC Chair

1 : select conference from menu

2 : evaluatePaper()

3 : request

4 : assignedPapers

5 : review

6 : press Save button7 : level of assessment

8 : sendMail()

Diagram 38: Evaluate Paper Sequence Diagram

Page 46: CONFMAN Software Design Description Document - METU

45

5.4.5 Author Sequence Diagrams

This section refers to sections “3.3.2.5 Author Use Cases” of CONFMAN SRS

document.

5.4.5.1 Upload Abstract Sequence Diagram

This section refers to “3.3.2.5.1 Use Case: Upload Abstract” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Author <<UI*>>

1 : select conference from menu

2 : uploadAbstract()

3 : press Browse button

4 : directories are listed

5 : select directory

6 : press OK button

7 : press Upload button

8 : added to abstracts

Diagram 39: Upload Abstract Sequence Diagram

Page 47: CONFMAN Software Design Description Document - METU

46

5.4.5.2 Upload Paper Sequence Diagram

This section refers to “3.3.2.5.2 Use Case: Upload Paper” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 40: Upload Paper Sequence Diagram

Author <<UI*>>

1 : select conference from menu

2 : uploadPaper()

3 : press Browse button

4 : directories are listed

5 : select directory

6 : press OK button

7 : press Upload button

8 : added to papers

Page 48: CONFMAN Software Design Description Document - METU

47

5.4.5.3 View My Papers Sequence Diagram

This section refers to “3.3.2.5.3 Use Case: View My Papers” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Author <<UI*>>

1 : select conference from menu

2 : viewPapers()

3 : papers

Diagram 41: View My Papers Sequence Diagram

Page 49: CONFMAN Software Design Description Document - METU

48

5.4.5.4 View Results Sequence Diagram

This section refers to “3.3.2.5.4 Use Case: View Results” section of SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Author <<UI*>>

1 : select conference from menu

2 : viewResults()

3 : papersResults

Diagram 42: View Results Sequence Diagram

Page 50: CONFMAN Software Design Description Document - METU

49

5.4.5.5 Register to Conference Sequence Diagram

This section refers to “3.3.1.5.5 Use Case: Register to Conference” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 43: Register to Conference Sequence Diagram

Author <<UI*>>

1 : select conference from menu

2 : registerToConference()

3 : secure page

4 : fill fields

Page 51: CONFMAN Software Design Description Document - METU

50

5.4.6 Publication Chair Sequence Diagrams

This section refers to sections “3.3.2.6 Publication Chair Use Cases” of CONFMAN SRS

document.

5.4.6.1 View Accepted Papers Sequence Diagram

This section refers to “3.3.2.6.1 Use Case: View Accepted Papers” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

opt

Publication Chair <<UI*>> Conference

1 : select conference from menu

2 : viewAcceptedPapers()

3 : request

4 : paperList

5 : press Download button

Diagram 44: View Accepted Papers Sequence Diagram

Page 52: CONFMAN Software Design Description Document - METU

51

5.4.7 Tourism Agency Chair Sequence Diagrams

This section refers to sections “3.3.2.7 Tourism Agency Chair Use Cases” of CONFMAN

SRS document.

5.4.7.1 View Participant Info Sequence Diagram

This section refers to “3.3.2.7.1 Use Case: View Participant Info” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

opt

Tourism Agency Chair <<UI*>> Conference

1 : select conference from menu

2 : viewParticipantInfo()

3 : request

4 : participantList

5 : press Download button

Diagram 45: View Participant Info Sequence Diagram

Page 53: CONFMAN Software Design Description Document - METU

52

5.4.8 Admin Sequence Diagrams

This section refers to sections “3.3.2.8 Admin Use Cases” of CONFMAN SRS

document.

5.4.8.1 Fix Reported Problems Sequence Diagram

This section refers to “3.3.2.8.1 Use Case: Fix Reported Problems” section of SRS

document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 46: Fix Reported Problems Sequence

Diagram

loop

Admin <<UI*>> System

1 : fixReportedProblems()2 : send request

3 : conflictsAndComplaints

4 : choose a problem

5 : resolve the problem

Page 54: CONFMAN Software Design Description Document - METU

53

5.4.8.2 Manage Conference Request Sequence Diagram

This section refers to “3.3.2.8.2 Use Case: Manage Conference Request” section of

SRS document.

*: UI refers to user interface. It is not an object of an existing class. It is used only to increase

understandability of the diagram.

Diagram 47: Manage Conference Request Sequence

Diagram

opt

[appropriate][appropriate]

opt

[not appropriate][not appropriate]

Admin <<UI*>>

1 : manageConfRequest()

2 : handle issues

3 : reject

Page 55: CONFMAN Software Design Description Document - METU

54

User Admin

Server

UI

User Management

Admin UI

Admin Management

Server Management

Database

« uses»«uses »

« uses»

5.5 Interface Viewpoint

Users (except admin) access the system database through user interface, whereas

admin can directly access the database.

Diagram 48: Interface Viewpoint

Page 56: CONFMAN Software Design Description Document - METU

55

5.5.1 User Interface

In this section, some parts of user interface are presented.

Diagram 49: Index Page

Diagram 50: User Page

Page 57: CONFMAN Software Design Description Document - METU

56

5.5.1.1 Conference Chair User Interfaces

Diagram 51: Registration Page

Diagram 52: Conference Chair Page

Page 58: CONFMAN Software Design Description Document - METU

57

5.5.1.2 TPC Chair User Interfaces

Diagram 53: Create Conference Page

Diagram 54: TPC Chair Page

Page 59: CONFMAN Software Design Description Document - METU

58

Diagram 55: Assign Reviewers Page

Diagram 56: Assign Papers Page

Page 60: CONFMAN Software Design Description Document - METU

59

5.5.1.3 PCM User Interfaces

Diagram 57: Accept/Reject Paper Page

Diagram 58: Reviewer Page

Page 61: CONFMAN Software Design Description Document - METU

60

Diagram 59: View Assigned Papers Page

Diagram 60: Evaluate Paper Page

Page 62: CONFMAN Software Design Description Document - METU

61

5.5.1.4 Author User Interfaces

Diagram 61: Author Page

Diagram 62: Upload Abstract Page

Page 63: CONFMAN Software Design Description Document - METU

62

Diagram 63: Upload Paper Page

Diagram 64: View Results Page

Page 64: CONFMAN Software Design Description Document - METU

63

6. Document Change History

Date Revision Comment Writer

02.12.2012 1.0 Created

Başak Elif AKGÜN

Selin AKİFOĞLU

Tolga ATALAY

Barış ÇAKAR

18.01.2013 1.1

“1.1 Brief summary of the

project” section is added.

“5.1 Context Viewpoint”

section is updated.

“5.2.1 Class Relationship”

section is updated.

“5.2.2 Diagram: User Class”

section is updated.

“5.2.5 Diagram: PCM Class”

section is updated.

“5.2.6 Diagram: Author Class”

section is updated.

“5.2.9 Diagram: Admin Class”

section is updated.

“5.4.1.4 View My Profile

Sequence Diagram” section is

added.

“5.4.1.5 Edit My Profile

Sequence Diagram” section is

added.

“5.4.1.6 Send Instant Message

Sequence Diagram” section is

renamed.

Başak Elif AKGÜN

Selin AKİFOĞLU

Tolga ATALAY

Barış ÇAKAR

Page 65: CONFMAN Software Design Description Document - METU

64

“5.4.4.2 View Assigned Papers

Sequence Diagram” section is

updated.

“5.4.4.3 Preview Paper

Sequence Diagram” section is

added.

“5.4.4.4 Download Paper

Sequence Diagram” section is

added.

“5.4.5.2 Upload Paper

Sequence Diagram” section is

added.

“5.4.5.2 Make Payment

Sequence Diagram” section is

removed.

“5.4.5.3 View My Papers

Sequence Diagram” section is

added.

“5.4.5.4 View Results

Sequence Diagram” section is

added.

“5.4.5.5 Register to

Conference Sequence Diagram”

section is updated.

“5.4.8.1 Modify Database

Sequence Diagram” section is

removed.

“5.4.8.1 Fix Reported

Problems Sequence Diagram”

section is added.

“5.4.8.2 View System Info

Page 66: CONFMAN Software Design Description Document - METU

65

Sequence Diagram” section is

removed.

“5.4.8.2 Manage Conference

Request Sequence Diagram”

section is added.

“5.4.8.3 Check for Problem

Sequence Diagram” section is

removed.

“5.5.1 User Interface” section

is added.

Table 1: Change History Table