Skip to content

Latest commit

 

History

History
739 lines (306 loc) · 25.4 KB

newReadme.md

File metadata and controls

739 lines (306 loc) · 25.4 KB

Software Requirements Specification

For NITCONF

Version 1.0 approved

Prepared by group 2

Table of Contents

. Revision History

Revision History

Revision History

Name Date Reason For Changes Version

1. Introduction

This project is a prototype for NITCONF, a conference website designed to facilitate the submission, review and evaluation of academic papers. The section for the Program Committee includes functionality that enables members to view the submitted papers, assign reviewers to them and decide whether to accept the papers or not . The repository encompasses the entire Program Committee section for this project. This document provides a fundamental overview of the project’s goals, highlighting the significance and utility of the software product, while also focusing on the target user base.

1.1 Purpose

The Program Committee platform provides a smooth and easy environment for Program Committee members to assign reviewers to review the papers submitted by authors.

1.2 Document Conventions

This document follows IEEE formatting requirements

1.3 Intended Audience

This document is intended to several groups of audience members

  1. System Designers :

    They are the primary audience. It provides crucial information guiding the design phase.

  2. Tester :

    They will refer to the SRS to ensure that the actual implementation aligns seamlessly with the specified requirements.

1.4 Product Scope

  1. User Authentication :

    A secure login page for the members of the Program Committee to access the system.

  2. Dashboard :

    After successful login, users are directed to a personalised homepage, having profile section, papers which are reviewed (view reviewed papers) and papers which are unreviewed (view unreviewed papers).

  3. Paper Presentation :

    The system organises the uploaded papers in a clear and systematic row-wise fashion for easy navigation.

  4. Program Committee Functionality :

    Program Committee members can seamlessly assign the reviewers to review the papers uploaded by the authors. Based on the reviews given by the reviewers, the Program Committee member decides whether to accept or reject the paper.

1.5 References

Refer to the following links for additional information :

https://www.springer.com/gp/computer-science/lncs/online-conference-service

https://support.springer.com/en/support/solutions/articles/6000245514-description-of- the-end-to-end-process-in-equinocs

2. Overall description

** 2.1 Product Overview**

The program committee page on NITCONF will function as an interface for program committee members to manage reviewer profiles. They can view all papers submitted by authors, assign reviewing tasks to reviewers, send reminders if reviewers are behind schedule, contact authors, and ultimately make decisions to ACCEPT or REJECT papers.

>>>>> gd2md-html alert: inline image link here (to images/image1.png). Store image on your image server and adjust path/filename/extension if necessary.
(Back to top)(Next alert)
>>>>>

alt_text

2.2 Product Functions

2.2.1.View Submissions by Authors:

Program committee can comprehensively view all papers submitted by authors, gaining a holistic understanding of the conference content.

2.2.2.Assign Reviewing Tasks to Reviewers:

Program committee members have the authority to strategically allocate reviewing tasks to specific reviewers, ensuring a balanced and thorough evaluation process.

2.2.3.Send Reminders for Reviewer Schedule:

The platform enables committee members to issue timely reminders to reviewers, helping to keep the evaluation process on track and ensuring deadlines are met

2.2.4.Contact Authors for Clarifications:

Committee members can easily communicate with authors, seeking clarifications or additional information to enhance the evaluation process.

2.2.5.Make Acceptance or Rejection Decisions:

Ultimately, the committee possesses the power to make crucial decisions regarding the acceptance or rejection of papers, shaping the final composition of the conference program.

2.2.6.Assign Additional Reviewer for Complex Cases:

In situations where committee members find it challenging to make decisions based on past reviews and comments, they can assign an additional reviewer to thoroughly assess the paper and contribute to informed decision-making.

2.2.7. Filter by Topic and Reviewer Ratings:

Committee members can utilise a sophisticated filtering system to categorise papers based on topic names, allowing for streamlined navigation. Additionally, they can filter papers based on the ratings assigned by reviewers, aiding in the efficient identification of noteworthy submissions.

2.3. User Classes and Characteristics

USER: PROGRAM COMMITTEE MEMBER

Frequency of Use: Program committee members engage with the system periodically throughout the conference planning and reviewing process. Focusing on strategic decision-making and oversight.

Functions Used:

  • View Submissions by Authors: Program committee members can comprehensively view all papers submitted by authors, gaining a holistic understanding of the conference content.

  • Manage their Profile: They can update their profiles, ensuring accurate and up-to-date information, enhancing the overall effectiveness of the reviewing process.

  • Assign Reviewing Tasks to Reviewers: Program committee members strategically allocate reviewing tasks to specific reviewers, ensuring a balanced and thorough evaluation process.

  • Send Reminders for Reviewer Schedule: The platform enables committee members to issue timely reminders to reviewers, helping to keep the evaluation process on track and ensuring deadlines are met.

  • Contact Authors for Clarifications: Committee members can easily communicate with authors, seeking clarifications or additional information to enhance the evaluation process.

  • Make Acceptance or Rejection Decisions: The committee possesses the power to make crucial decisions regarding the acceptance or rejection of papers, shaping the final composition of the conference program.

  • Assign Additional Reviewer for Complex Cases: In situations where committee members find it challenging to make decisions based on past reviews and comments, they can assign an additional reviewer to thoroughly assess the paper and contribute to informed decision-making.

Technical Expertise: Program committee members should have a good understanding of the conference management system, as they are involved in various managerial and decision-making tasks. They don't need to be as technically proficient as reviewers but should be comfortable navigating the system.

**Security Levels: **Program committee members require secure login credentials to access the system, ensuring the confidentiality and integrity of the reviewing and decision-making process.

**Educational Level and Experience: **Program committee members possess significant expertise in their respective academic or industry fields. They have experience in conference organisation and management, enabling them to make informed decisions about paper acceptance or rejection. Their experience also allows them to effectively manage the reviewing process and assign tasks strategically.

2.4 Operating Environment

The Program Committee Page of NITCONF is designed to operate within a well-defined environment, incorporating key features that ensure optimal functionality, security, and performance. The operating environment encompasses hardware, software, network conditions, performance expectations, security measures, compatibility considerations, and external dependencies.

2.4.1 Hardware Requirements:

The system requires a dedicated server with modern processors, at least 8GB of RAM, and sufficient storage capacity to handle concurrent user sessions and data storage.

2.4.2 Software Requirements:

  • The server must run a Java-compatible environment, with the choice of web servers like Apache Tomcat or Jetty, and Java JDK 8 or higher.
  • Frontend technologies such as HTML5, CSS3, and JavaScript are utilised for the user interface.

2.4.3 Network requirements

  • Adequate bandwidth and network stability are crucial for seamless access and data exchange, especially for real-time features.
  • The system uses HTTPS for secure communication over the internet.

2.4.4 Performance Requirements:

  • The system aims for optimal performance, recommending modern processors, at least 8GB of RAM, and a stable internet connection for laptop and desktop users.
  • Performance expectations include responsive web pages, low latency, and scalability to handle varying user loads

2.4.5 Security Requirements:

  • The system implements HTTPS for secure communication.
  • Security considerations include user authentication, authorization mechanisms, and data protection measures to ensure the confidentiality and integrity of user information.

2.4.6 Compatibility Requirements:

  • The application is designed for cross-platform compatibility, ensuring it runs smoothly irrespective of the user's operating system.
  • It is compatible with modern web browsers, including Google Chrome, Mozilla Firefox, Microsoft Edge, and Safari.

2.4.7 Dependencies:

  • The system relies on the Spring Framework (specific version as per development), a compatible database (e.g., MySQL, PostgreSQL), and frontend technologies (HTML5, CSS3, JavaScript).
  • Containerization is achieved using Docker and Kubernetes, and API testing tools such as Postman, swagger.io, and SoapUI are integrated into the development and testing process.

2.5 Design and implementation constraints

2.5.1 User Interface Consistency:

  • Constraint: Ensure a consistent and intuitive user interface across all sections of the Program Committee Page.
  • Implementation: Adhere to a unified design language, common navigation patterns, and consistent layout elements to provide a seamless user experience.

2.5.2 Responsive Design:

  • Constraint: Design the user interface to be responsive and adaptable to various screen sizes and devices.
  • Implementation: Utilise responsive design principles, CSS media queries, and flexible layouts to ensure optimal viewing on desktops, laptops, tablets, and smartphones.

2.5.3 Scalability:

  • Constraint: Design the system to handle a potentially large number of papers, reviewers, and program committee members.
  • Implementation: Utilize scalable database architecture, optimize queries, and implement caching mechanisms to maintain performance as the user base and data volume grow.

2.5.4 Notification Mechanism:

  • Constraint: Implement a real-time notification system for Program Committee members.
  • Implementation: Integrate a notification mechanism to alert committee members about new submissions, review comments, and decision outcomes promptly.

2.5.5 Review Process Workflow:

  • Constraint: Define and implement a structured workflow for the review process.
  • Implementation: Develop clear steps for paper submission, reviewer assignment, review comments, and final decision-making. Ensure that the workflow is intuitive and follows the conference's guidelines.

2.5.6 Security Measures:

  • Constraint: Implement robust security measures to safeguard user data and maintain the confidentiality of the review process.
  • Implementation: Employ encryption for data transmission, secure user authentication, and authorization mechanisms. Regularly update security protocols to address potential vulnerabilities.

2.5.7 Integration with Reviewer Section:

  • Constraint: Facilitate seamless communication and data exchange between the Program Committee and Reviewer sections.
  • Implementation: Develop APIs or data-sharing mechanisms to enable smooth integration between the Program Committee and Reviewer sections, ensuring consistent data flow and accuracy.

2.5.8 Data Privacy Compliance:

  • Constraint: Ensure compliance with data protection regulations.
  • Implementation: Incorporate features for data anonymization, obtain consent where necessary, and ensure that the system adheres to relevant data protection laws such as GDPR.

2.5.9 Backup and Recovery:

  • Constraint: Establish a robust backup and recovery system for data preservation.
  • Implementation: Regularly back up the database, implement version control for the codebase, and devise a recovery plan to minimize data loss in case of system failures.

2.5.10 Documentation:

  • Constraint: Provide comprehensive documentation for future maintenance and updates.
  • Implementation: Document the codebase, APIs, database schema, and system architecture thoroughly. Create user manuals to guide Program Committee members through the functionalities of the system.

2.5.11 User Training:

  • Constraint: Consider the varying technical proficiency of Program Committee members.
  • Implementation: Develop training materials, tutorials, or conduct training sessions to ensure that Program Committee members can effectively use the system to perform their tasks.

2.6 User Documentation

Login and Dashboard Navigation .

  • Login : Program committee members log in with their credentials and are directed to the member's dashboard.
  • Profile: The User’s profile icon is displayed in the top right corner, linking to the profile page.
  • **Side Navigation Bar: **Features a collapsible navigation with the following options:
  • View Reviewed Papers
  • View UnReviewed Papers.

Pages and Functionalities

‘View Reviewed Papers’ Page

  • Layout - Displays the reviewed papers in a row-wise manner

**Columns : **

i. Filter : includes a filter button to display the required papers based on topic.

ii. View a reviewed paper : Here it shows paper title and some information regarding the paper and display paper upon clicking on it

iii. Status : indicates the status of the assigned reviewers for each paper (is reviewed or not ).

iv. _Add reviewer _: here program committee members can add reviewer if needed for further review.

v. accept/reject : program committee members can decide whether to accept the paper or to reject it.

‘View Unreviewed Papers’ Page

  • Layout - Displays the unreviewed papers in a row-wise manner.

Columns :

i. _Filter _: includes a filter button to display the required papers based on topic.

ii. View unreviewed paper : Here it shows paper title and some information regarding the paper and display paper upon clicking on it

iii. Assign reviewer : here committee members can add reviewer to each paper to review and send mail to the reviewer (to notify reviewer).

iv. Contact Author : For any queries regarding the submitted papers committee members can contact the respective author.

v. Status : Here it shows the status of reviewer (is reviewed or not ).

vi. _Send Reminder _: send reminder to the reviewer if he has not reviewed the assigned paper.

2.7 Assumptions and Dependencies

2.7.1 Assumptions

  • Active Participation of Reviewers:

    It is assumed that assigned reviewers will actively participate in the review process, providing timely and thorough assessments of submitted papers.

  • Reviewer Availability:

    The system assumes that reviewers are available to fulfil their reviewing tasks within the designated timelines.

  • Reviewer Proficiency:

    It is assumed that Program Committee members and reviewers possess the necessary technical skills to navigate and interact with the web-based system effectively.

  • Access to Devices:

    Users are assumed to have access to reliable internet connectivity and devices capable of running standard web browsers.

2.7.2 Dependencies

  • Database Management System:

    The system is dependent on a compatible database management system, such as MySQL, PostgreSQL, or similar, for storing and retrieving data related to papers, reviewers, and decisions.

  • Web Server:

    The web application relies on a compatible web server, such as Apache Tomcat or Jetty, for hosting and serving pages. Any changes to the web server may affect the system's performance.

  • Fronted Technologies:

    The system utilizes frontend technologies like HTML5, CSS3, and JavaScript for creating an interactive user interface. Changes in these technologies or browser updates may impact the user experience.

  • Browser Compatibility:

    The System is dependent on users accessing it through modern web browsers (Google Chrome , Mozilla FireFox, Safari, etc.). The documentation will provide information on recommended browsers for optimal performance.

  • User Account Management:

    The Successful Functioning of the Program Committee module is dependent on the proper management of user accounts, including the creation , modification, and deletion of accounts as needed.

3. System Features

3.1 Login and Validation

3.1.1 Description and Priority

This feature enables users to log in and validates their credentials. It is of High priority.

3.1.2 Stimulus/Response Sequences

  • User provides login credentials.
  • System validates credentials.
    • If validation fails, return to the Login feature.
    • If validation succeeds, proceed to the Profile, View-reviewed-papers, and View-all-papers features.

3.1.3 Functional Requirements

  1. User Login: Users must be able to input their credentials.
  2. Credential Validation: The system must verify the provided credentials.
  3. Redirect to Profile: If validation succeeds, redirect the user to the Profile feature.
  4. Redirect to View-reviewed-papers: If validation succeeds, redirect the user to the View-reviewed-papers feature.
  5. Redirect to View-all-papers: If validation succeeds, redirect the user to the View-all-papers feature.

3.2 System Feature: Profile

3.2.1 Description and Priority

This feature allows users to manage their profile information. It is of Medium priority.

3.2.2 Stimulus/Response Sequences

  • User accesses the Profile feature.
  • Users update profile information.

3.2.3 Functional Requirements

  1. View Profile: Users can view their profile information.
  2. Edit Profile: Users can edit and update their profile details.

3.3 System Feature: View-reviewed-papers

3.3.1 Description and Priority

This feature allows users to view reviewed papers and take actions on them. It is of High priority.

3.3.2 Stimulus/Response Sequences

  • User accesses the View-reviewed-papers feature.
  • User performs actions like Accept, Reject, or Assign Reviewer on a paper.

3.3.3 Functional Requirements

  1. List Reviewed Papers: Display a list of reviewed papers.
  2. Accept Paper: Allow the user to accept a reviewed paper.
  3. Reject Paper: Allow the user to reject a reviewed paper.
  4. Assign Reviewer: Allow the user to assign a reviewer to a paper.

3.4 System Feature: View-all-papers

3.4.1 Description and Priority

This feature enables users to view all papers and perform various actions. It is of Medium priority.

3.4.2 Stimulus/Response Sequences

  • User accesses the View-all-papers feature.
  • Users perform actions like filtering, adding reviewers, sending reminders, and contacting authors.

3.4.3 Functional Requirements

  1. List All Papers: Display a list of all papers.
  2. Filter Papers: Allow the user to filter papers based on criteria.
  3. Add Reviewer: Enable the user to add a reviewer to a paper.
  4. Send Reminder: Allow the user to send reminders to authors.
  5. Contact Author: Provide a means for users to contact paper authors.

4. Other Nonfunctional Requirements

4.1 Performance Requirements

4.1.1 System Responsiveness

  • The login process should have an average response time of less than 3 seconds.
  • Paper assignment to reviewers should occur within 5 seconds of submission.

4.1.2 Concurrent User Handling

  • The system should support up to 100 concurrent users during peak times without performance degradation.

4.1.3 Database Query Performance

  • Database queries related to paper submissions and reviews should execute in less than 3 seconds.

Rationale:

  • Timely responses are crucial for user satisfaction and efficient workflow.
  • Efficient handling of concurrent users is essential for a smooth conference experience.
  • Quick access to data is necessary for effective paper management and decision-making processes.

4.2 Safety Requirements

4.2.1 Data Integrity

  • Safeguards must be in place to ensure the integrity of all data stored in the system.
  • Regular backups of the system data should be performed to prevent data loss.

4.2.2 User Authentication

  • All user authentication processes must comply with industry standards to prevent unauthorized access.
  • Failed login attempts should be monitored and trigger account lockout after a specified number of unsuccessful tries.

4.2.3 Compliance with Privacy Regulations

  • The system must adhere to data protection regulations and ensure the privacy of user information.

Rationale:

  • Ensuring data integrity is crucial for maintaining accurate and reliable information.
  • Secure user authentication is necessary to prevent unauthorized access and protect user accounts.
  • Compliance with privacy regulations is essential for legal and ethical considerations.

4.3 Security Requirements

4.3.1 Encryption

  • All data transmitted between the user's browser and the server must be encrypted using HTTPS.
  • User passwords must be stored securely using strong, industry-standard hashing algorithms.

4.3.2 Access Control

  • Different user roles (e.g., admin, reviewer, author) must have specific access permissions to ensure data confidentiality and integrity.

4.3.3 Security Auditing

  • Regular security audits and vulnerability assessments should be conducted to identify and address potential security issues.

Rationale:

  • Encryption safeguards sensitive data during transmission, protecting it from unauthorized access.
  • Access control measures prevent unauthorized users from accessing or modifying data.
  • Regular security audits help identify and address potential vulnerabilities, ensuring a secure system.

4.4 Software Quality Attributes

4.4.1 Usability

  • The user interface should follow standard practices to ensure an intuitive and user-friendly experience.

4.4.2 Maintainability

  • Code should be well-documented, and modular to facilitate ease of maintenance and future enhancements.
  • Changes to the system should be deployable with minimal downtime.

4.4.3 Reliability

  • The system should have an uptime of at least 99% during peak conference times.
  • The system will not lag and will provide instant and accurate results to all the users.

4.4.4 Portability

  • The system can be accessed on any smartphone or laptop.

Rationale:

  • Usability is critical for user satisfaction and efficient system utilization.
  • Maintainability ensures the longevity and adaptability of the system.
  • Reliability is essential to prevent disruptions during critical conference periods.

4.5 Business Rules

4.5.1 Role-Based Functions

  • Authors can submit papers and view the status of their submissions.
  • Reviewers can access and review assigned papers.
  • Members of the Program Committee can view all the submissions, assign reviewers for the same and accept or reject them.

Role-based functions ensure that users can only perform actions relevant to their responsibilities.