Project Deliverable 3

CS- 631 | Database Management Design | Final Report

Project Report

Library Database ApplicationDatabase Management Design

CS-631 FALL 2016

Team Members:Sai Akhil Reddy Gopidi (31395526)

Parikshit Madahar (31403003)Charitharth Kasireddy (31389542)

1


CONTENTS

1 Project Overview.................................................................................................................................3

1.1 Introduction-................................................................................................................................3

1.2 Problem Statement-....................................................................................................................3

1.3 Project Goal-................................................................................................................................3

1.4 Implementation-..........................................................................................................................3

1.5 Problems Faced-..........................................................................................................................4

1.6 Revisions Made-...........................................................................................................................4

2 EER Model...........................................................................................................................................5

3 Relational Schema...............................................................................................................................5

4 DDL file used to create database tables..............................................................................................6

4.1 Code To Create Tables-................................................................................................................7

4.2 Screen Shots of Tables-..............................................................................................................17

5 Constraints and limitations................................................................................................................22

6 User guide and functions...................................................................................................................23

6.1 User-..........................................................................................................................................23

6.2 Admin-.......................................................................................................................................24

7 Future Works.....................................................................................................................................26

8 Screenshots.......................................................................................................................................27

2


1 PROJECT OVERVIEW

1.1 INTRODUCTION-The Library Database Application is Library management software for monitoring and controlling the transactions in a library system comprising of all the branches in different neighborhoods of a city. This application mainly focuses on basic operations of a library admin like searching for documents, adding new member, new documents, and updating new information while the readers are given the option to reserve books and search documents with advanced search options. Various constraints and limitations are also added that will be described later on in this report.

1.2 PROBLEM STATEMENT-The task at hand is to create a library database application for a library that is located in different neighborhoods of a city. The application must allow users to browse through the catalogs and documents in the library and the entire details related a particular document. It must also keep tract of books that are being borrowed and reserved by the readers, the due date of submission and fine for late returning.

1.3 PROJECT GOAL-Our goal in the first phase of the project was to analyze the requirements of the library database and to design an Extended Entity Relationship diagram intended database.

Our goal in the second phase was to design a relational scheme for the library database based on the ER diagram and EER diagram that was designed in the project deliverable 1. Once the relational schema is designed we map the foreign keys in reference relation to the primary keys in referred table to develop to relationship between multiple relations.

Our current goal is to develop a working system for the library application and connect it with the newly created database successfully to perform various function, processes and system requirements successfully. The application must not crash in case of violations of any constraints and a proper error message must be displayed to the user. The tables must be well described to store ample data to run all the required tasks.

1.4 IMPLEMENTATION-This project is developed using html, css and bootstrap for the front end design and SQL queries embedded in PHP to perform the backend operations along with the help of Wamp server and MYSQL database.

3


1.5 PROBLEMS FACED-Few functionalities that could not be implemented due to high complexity and time constraint-

1. The application doesn’t allow a reader to search for similar documents given a document. We tried to minimize this defect in the keyword search feature where similar documents are displayed with similar keywords.

2. Placing the reader in waiting list and ordering a new document from a different branch.

Difficulties that we overcame-

1. Using the date and time function in php created a problem since the Eastern Standard Time was not being taken and Greenwich Mean Time was being taken. We face problem in converting the datetime function output from string to time format and them correcting the time to Eastern Standard Time.

2. SQL queries embedded in PHP couldn’t recognize the AS clause, so commands like document AS D and D.docid could not be executed as per planned. We wasted a lot of time in realizing to remove the AS clause and then executing the query which then worked perfectly.

3. There was a lot of brainstorming ideas among the team members in designing the User Interface (front end) since we wanted keep the application as simple as possible yet attractive. We had problems in finalizing the best user interface.

1.6 REVISIONS MADE-Three tables have been deleted from the relation schema that was designed in the second deliverable due to redundancy.

1. HAS table is deleted because it has the same attributes as that of COPY table. Therefore, to reduce redundancy HAS table is deleted.

2. BORROWS table is merged with Bor_Transaction table since both of them exist to store information about borrowed document and reader.

3. RESERVES table is merged with RESERVATION table since both of them exist to store information about reserved document and reader.

Though there is no redundancy in the 2nd and 3rd table merging yields an optimized way to create tables which in turn increases the efficiency of the application and reduces complexity while writing the queries (especially those with joins involved).

4


2 EER MODEL

The above diagram shows the EER (Enhanced Entity Relationship) Model used in designing the database for the library database application.

3 RELATIONAL SCHEMAThe following diagram show the Relational Schema to the above described EER diagram for the library database application.

5


4 DDL FILE USED TO CREATE DATABASE TABLESThe below picture shows the code show used in creating a new database called gotham_library.

6


The following code shows the SQL Data definition language that was used to create the tables in gotham_library database.

4.1 CODE TO CREATE TABLES-<?php

$con= mysqli_connect("localhost","root","","gotham_library");

//creating tables

//document table

$sql = "CREATE TABLE document

(DocId INT NOT NULL,

Title VARCHAR(50) NOT NULL,

PublishDate DATE NOT NULL,

PubId VARCHAR(25),

PRIMARY KEY(DocId),

FOREIGN KEY (PubId) REFERENCES publisher(PubId))";

$row=mysqli_query($con,$sql);

7


if($row){

echo "table documents created successfully";

}

else{

echo "error in creating the table".mysqli_error($con);

}

//Library branch table

$sql = "CREATE TABLE libraryBranch

(LibId VARCHAR(25) NOT NULL,

LibraryName VARCHAR(50) NOT NULL,

Location VARCHAR(50) NOT NULL,

PRIMARY KEY(LibId))";


if($row){

echo "table libraryBranch created successfully";

}

else{


}

//document descriptor table

$sql = "CREATE TABLE docDescriptor


Descriptor VARCHAR(50) NOT NULL,

8


PRIMARY KEY(DocId, Descriptor),

FOREIGN KEY (DocId) REFERENCES document(DocId))";


if($row){

echo "table descriptor created successfully";

}

else{


}

//reader table

$sql = "CREATE TABLE reader

(ReaderId VARCHAR(25) NOT NULL,

ReaderName VARCHAR(50) NOT NULL,

Address VARCHAR(50) NOT NULL,

ReaderType VARCHAR(15) NOT NULL,

PhoneNumber VARCHAR(10) NOT NULL,

PRIMARY KEY(ReaderId))";


if($row){

echo "table reader created successfully";

}

else{


}

9


//publisher table

$sql = "CREATE TABLE publisher

(PubId VARCHAR(25) NOT NULL,

PubName VARCHAR(50) NOT NULL,

Address VARCHAR(50) NOT NULL,

PRIMARY KEY(PubId))";


if($row){

echo "table publisher created successfully";

}

else{


}

//author table

$sql = "CREATE TABLE author

(AuthorId VARCHAR(25) NOT NULL,

AuthorName VARCHAR(50) NOT NULL,

PRIMARY KEY(AuthorId))";


if($row){

echo "table author created successfully";

}

else{


10


}

//writes table

$sql = "CREATE TABLE writes

(AuthorId VARCHAR(25) NOT NULL,

DocId INT NOT NULL,

PRIMARY KEY(AuthorId,DocId),

FOREIGN KEY (AuthorId) REFERENCES author(AuthorId),



if($row){

echo "table writes created successfully";

}

else{


}

//books table

$sql = "CREATE TABLE books


ISBN VARCHAR(13) NOT NULL,

PRIMARY KEY(DocId),



if($row){

11


echo "table books created successfully";

}

else{


}

//borrow table

$sql = "CREATE TABLE borrows

(BorNum VARCHAR(25) NOT NULL,

ReaderId VARCHAR(25) NOT NULL,

DocId INT NOT NULL,

LibId VARCHAR(25) NOT NULL,

CopyNo VARCHAR(25) NOT NULL,

BorDateTime DATETIME NOT NULL,

RetDateTime DATETIME NOT NULL,

Fine DECIMAL,

PRIMARY KEY(BorNum),

FOREIGN KEY (ReaderId) REFERENCES reader(ReaderId))";


if($row){

echo "table borrows created successfully";

}

else{


}

12


//reserves table

$sql = "CREATE TABLE reserves

(ResNum VARCHAR(25) NOT NULL,

ReaderId VARCHAR(50) NOT NULL,

DocId INT NOT NULL,



ResDateTime DATETIME NOT NULL,

PRIMARY KEY(ResNum),

FOREIGN KEY (ReaderId) REFERENCES reader(ReaderId))";


if($row){

echo "table reserves created successfully";

}

else{


}

//copy table

$sql = "CREATE TABLE copy




Position VARCHAR(20) NOT NULL,

PRIMARY KEY(DocId, LibId, CopyNo),

13


FOREIGN KEY (DocId) REFERENCES document(DocId),

FOREIGN KEY (LibId) REFERENCES libraryBranch(LibId))";


if($row){

echo "table copy created successfully";

}

else{


}

//proceedings table

$sql = "CREATE TABLE proceedings


CDate DATE NOT NULL,

CLocation VARCHAR(25) NOT NULL,

CChair VARCHAR(25) NOT NULL,

PRIMARY KEY(DocId),



if($row){

echo "table proceedings created successfully";

}

else{


}

14


//cEditor table

$sql = "CREATE TABLE cEditor

(cName VARCHAR(25) NOT NULL,

CEditorId VARCHAR(25) NOT NULL,

PRIMARY KEY(CEditorId))";


if($row){

echo "table ceditor created successfully";

}

else{


}

//Journal_vol table

$sql = "CREATE TABLE journalVol


VolNo INT NOT NULL,

CEditorId VARCHAR(25) NOT NULL,

PRIMARY KEY(DocId, CEditorId),

FOREIGN KEY (DocId) REFERENCES document(DocId),

FOREIGN KEY (CEditorId) REFERENCES cEditor(CEditorId))";


if($row){

echo "table Jvol created successfully";

}

15


else{


}

//Journal_issue table

$sql = "CREATE TABLE journalIssue


issueNo INT NOT NULL,

scope VARCHAR(100),

PRIMARY KEY(DocId, issueNo))";


if($row){

echo "table Jissue created successfully";

}

else{


}

//IEditor table

$sql = "CREATE TABLE iEditor


issueNo INT NOT NULL,

iEditorName VARCHAR(25) NOT NULL,

PRIMARY KEY(DocId, issueNo),


16



if($row){

echo "table ieditor created successfully";

}

else{


}

?>

There are a total of 16 tables.

Relation Name Primary Key Foreign Key

Document Doc_Id Publisher_IdLibrary_Branch Lib_Id

Reader Reader_IdBor_Transaction BorNumber

Reservation ResNumberPublisher Publisher_Id

Author Author IdCopy Doc_Id, Lib_Id, Copy Number Doc_Id, Lib_Id

Writes Author Id, Doc_Id Author Id, Doc_IdDoc_Descriptor Doc_Id, Descriptor Doc_Id

Book Doc_Id Doc_IdProceedings Doc_Id Doc_Id

Journal Volume Doc_Id Doc_Id, Editor IdChief Editor EdiotrId

Journal Issue Doc_Id, IssueNumber Doc_IdIEditor Doc_Id, IssueNumber, Edition Doc_Id, IssueNumber

4.2 SCREEN SHOTS OF TABLES-

17


Author Table Books Table

Chief Editor Table

18


Borrows Table

Copy Table

19


Document Descriptor Table

Document Table

Issue Editor Table

Journal Issue Table

20


Journal Volume Table

Library Branch Table

Conference Table

Publisher Table

21


Reader Table

Writes Table

5 CONSTRAINTS AND LIMITATIONSThe constraints and limitations that implemented in the application are-

1. A single reader cannot borrow more than 10 documents, i.e. the reader cannot have more than 10 documents with him at any given point of time. The reader can reserve documents even if he has borrowed 10 documents but at the time of confirmation, the alert message will be shown.

2. The documents reserved by a reader are stored in a reserves table. The application is designed in such a way that that the table automatically deletes its contents when the time crosses 6 P.M on that day, which means that if the admin tries to confirm a document after 6 P.M he will see an empty table. The reserve option will be blocked for the readers the time is 6 P.M. All the tuples in reserves table will be deleted and added to copy table, which means the readers

22


can reserve the document on the following day. This process is iterative and is repeated every day.

3. When the reader tries to login using his reader id, only those readers who have a valid reader id will be able to login.

4. A reader can borrow multiple documents but no two readers can borrow the same copy of a same document at the same time.

5. A reader cannot be removed from the database if he has a document on his name.6. In case the admin tries to enter copies of documents that are not yet entered into the

database, an error message is displayed. Only those documents that have a document id and are registered in the system will have copy number. Similarly, if the admin tries to enter the copy number in a non-existing library an error message is displayed.

7. The return date of a document that is currently being circulate is displayed as 0000-00-00 00:00:00, otherwise the return time is displayed.

8. In case there the search results are empty or there are no documents borrowed by a reader, a blank table is displayed with the table heading.

9. Journal cannot have more than 10 issues.10. Only the admin has the power to issue, cancel and return documents. The reader can only

reserve the document.

6 USER GUIDE AND FUNCTIONS

The users (admin and readers) first visit the home page of the library web application. This interface will be same for both readers and admin.

6.1 USER-To view the documents that are currently present in the library system and reserve them the users can enter their Reader Id in the space provided. Only the users whose reader id is registered in the system can login. After logging in the users are provided with 4 different search options- they can either search using-

1. Document Title- Provides list of all documents matching with the title2. Library Name- Provides list of all documents in that library3. Author Name- Provides list of all documents written by that author4. Keywords- Provides list of all documents that contains the mentioned keywords.

After entering their search option and clicking on the search button they are redirected to the respective search page where details of the document that they searched for are displayed in this order- Document Id, Document Title, Library Id, Library Name Copy Number and Reserve option. Only those documents that are available to be borrowed/reserved are displayed in the

23


search results. When the readers click on the reserve option the selected document is deleted from the copy table and inserted into the reserves table. This function is done in the backend and is invisible to the user. Once the document is inserted into the reserves table it won’t be displayed any other user who searches for the same document again. The reserve option is available to the users only before 6 P.M on the respective day and the reserved document will be available till 6 P.M only. If the document is not collected it is deleted from the reserves table and added back to the copy table. No fine will be issued if the reader reserves the document and doesn’t collect it with in due time. So the next time a user searches for this document it will be displayed in the search table.

6.2 ADMIN-The admin can enter his/ her login details using the ‘Admin Login’ button in the navigation bar in the common home page. As of now the only login credentials that are accepted are-

Email id- [email protected]

Password- library

After entering the correct login details the admin is redirected to the admin home page which has various options in the dashboard.

1. Search- The author can search for various documents according to title, library name, author and keywords in a similar way to that of the reader. The admin will not have an option to reserve or borrow the documents like the reader.

2. Document Details- This section has four tabs, one for adding a new document copy, one for adding new book details, one for adding new conference details and the last for adding new journal details.

a. Add a new copy tab takes the admin to a form where they have to enter the document and library details as well as the copy number and the position where it has to be stored in the library. Only those documents that are already registered in the system can have document copies entered. Otherwise error message will be displayed.

b. Add book details displays a form for entering all the details that are relevant to a book like ISBN number. This option must be used if the book is new to the entire library system. If a new copy of the book arrives then add new copy option must be used.

c. Add conference details displays a form for entering all the details that are relevant to a conference like location of conference and proceeding chair of the event. This

24


option must be used if the conference is new to the entire library system. If a new copy of the conference arrives then add new copy option must be used.

d. Add journal details displays a form for entering all the details that are relevant to a journal like journals chief editor’s details, guest editor name, issue number, scope and volume. This option must be used if the journal is new to the entire library system. If a new copy of the journal arrives then add new copy option must be used.

3. Reader Details- This section has two tabs, one for Adding New Reader Details and another for viewing the existing reader details.

a. Add new reader tab takes the admin to a form that takes input from the admin regarding the new reader. On clicking submit the details are store in the reader table and the user can use this reader id to reserve books online.

b. View reader details tab displays the reader table with the list of readers and an option to deleted the current readers provided that they didn’t borrow or reserve any book. On clicking the reader id of a particular reader (reader id highlighted in blue) the admin is taken to a new page that displays the list of documents that the user has borrowed in the past as well as the books that are with him right now. The table shows in detail the document id and copy no of the document that is borrowed and from which library it has been borrowed along with the borrow date. The return date displays ‘0000-00-00 00:00:00’ if the reader has not yet returned the document otherwise the return date is also specified. In case late return the fine is generated and displayed in this section itself. No fine means that the book is returned before the due date.

4. Transaction Details- This section has two tabs, one is Click for borrowing/ returning and another for reserving.

a. Click for borrowing/ returning tab take the admin to a page with two different form. One is for entering the details of the document which the user wants to borrow. The reader, document and copy number is submitted in the form. These details will be added in the borrows table. Once a reader borrows a copy of a book another reader will not be able to borrow or reserve it.The second form is for returning the borrowed documents. The admin enters the reader id of the reader. A list is displayed showing all the documents that the reader has borrowed previously and the copies that are with him right now. The admin can click on the return option (highlighted in red) to take back the returned document. This copy is now available for other reader who wants to reserve/ borrow it. In order to view the fine is case of late return the admin must go back to view reader details tab and click on the reader id to see the fine if there is any.

25


b. Click for reserving tab displays the admin the list of documents that the readers have reserved on that day. There are two options, one for confirming the reservation and another or canceling the reservation. The table is visible to the admin only before 6 P.M and after that the table is blank and these documents are available for circulation for other readers. If the reader doesn’t claim the document before 6 P.M it is deleted from the reserves table is will be available for other users for borrowing and also for reserving on the next day. The same function is repeated when the admin decides to cancel the reservation. If the admin clicks on confirm reservation the tuple is added to borrows table from the reserves table and then deleted from the reserves table. In this case the document copy will not be visible to other readers.

Common properties like document id, title, publish details and author details are common for all the documents. Therefore, they are included in every form.

Multiple readers cannot borrow same copy of a same document but they can borrow different copies of the same document. The system does not allow the reader to borrow more than 10 documents at a time.

If the tables have nothing to display a blank table with only the headers is displayed.

Both the admin and reader can use the logout option to end the session and logout.

7 FUTURE WORKSSome of the additional features that we would like to implement are-

1. A new table can be added to the existing database called ‘Waitlist’. If a reader orders for a document that is not present in his current library, his reader id, the document id that the reader wants, library id from which the document is being borrowed from and library id to which the document is being transferred to can be stored in this table. This table will be made visible to the readers who order the book to know the status of their order.

2. Improving the user interface. The current interface is little vague, for example if a reader returns the book after due date, the fine is calculated and is shown in the reader details page. The admin will have to go back check the fine for the respective document again.

3. Static information of each library branch can be added. The total number of documents in circulation from each branch, number of documents available in each branch can be calculated and displayed to the admin.

4. A list of popular documents or trending documents can be made and displayed to the readers when they try to search for a document. Trending documents can be found out by counting the

26


number of times a copy of a document is reserved/ borrowed. The documents with the highest count can be shown in the trending column to the readers.

8 SCREENSHOTS

Tables created in gotham_library database for the application

27


Home page common for both admin and reader. They can enter their login details here.

Admin Login

28


Document search common for admin and readers

29


Result of searched documents. Readers can reserve using Reserve option.

Revering denied if the user tries to reserve after 6 P.M

30


Admin home page

Form to add reader details

31


Table showing registered readers. The admin can remove the readers using remove option.

List of documents borrowed by a reader. Included fine also

32


1. Form to enter document details being borrowed2. Form to return documents borrowed by a user

33


Table showing list of documents borrowed by user. Return option allows admin to take back borrowed document

Table showing list of all the reserved documents. Confirm allows the admin to issue the document to the reader. Cancel option cancels reservation and borrowing. This table will be displayed only till 6 P.M on any day.

34


Form to enter the copy and position details of a document in a particular library

Form to enter book details

35


Form to enter conference details

Form to enter Journal details

36


Error message being show in case of constraint violations

Error message showing only 10 documents can be borrowed at a time.

37


THANK YOU

38

Project Deliverable 3

Documents

Transcript of Project Deliverable 3