DocumentQueue

University PHP/MySQL project intended to alleviate the amount of email and email attachment / document shuffling that is ubiquitous throughout university and school departments. Often, students are required by educational institutions to submit documentation for the purpose of waiving course requirements, study plan approvals, and many other scenarios. This documentation must then be reviewed and approved by appropriate faculty. Additionally, other use cases require a similar workflow. For example, Applications for Candidacy and Study Plans must be reviewed and approved by advisors. The purpose of the Online Document Queue application is to provide:

• Faculty with the ability to create course and personal document queues
• Faculty to define required document submissions for each queue that they own
• Faculty with the ability to review, approve, and update submitted documentation
• Students with the ability to electronically submit required documentation to queues

TO DO

• Utilize composer functionality and remove all unnecessary files/modules from the git repository
• Completion of the approval functionality
• Cleanup UI
• Move and document To Do items using git project issues

Dependencies

1. Apache mod_rewrite, php5_module
2. PHP >=5.6
3. Mysql
4. (Optional) PHP File Info module (php_fileinfo) - Used to detect file mime types on the server side vs. assuming that the client browser correctly detects mime types for file uploads

Installation

Database

• Create database using /app/sql/documentmanager.sql
• Create database user using your preferred method and ensure the user has permissions to the database

The /app/sql/documentmanager.sql SQL script creates the document_manager database, required tables and the following seed data:

• Roles:

  • ADMIN
  • ADVISOR
  • INSTRUCTOR

• Users (email/password):

  • admin@stevens.edu / admin
  • advisor@stevens.edu / advisor
  • instructor1@stevens.edu / instructor
  • instructor2@stevens.edu / instructor
  • instructor3@stevens.edu / instructor
  • student1@stevens.edu / student
  • student2@stevens.edu / student

• Courses:

• 22 Courses with Instructors 1,2, and 3 assigned as coordinator (i.e. Instructor) for various courses

• Queues:

• Add/Drop Queue for each course

• Queue Elements:

• Add/Drop Form Element Required for each of the Add/Drop Course Queues

Web

• For a quick, unsecure development or testing installation, place the contents of this application in a folder of your choice. For example, create a folder called doc_manager under you web server's document root and place all files within this folder. Note: This type of setup should not be used for production.
• For security reasons, the only folder that should be accessable from the web is the /public folder. Otherwise, sensistive configuration and application files will be accessable from the web.
• For a production environment, ensure only the /public folder is accessable from the web. Using Apache web server, the Directory, Alias, or Virtual Hosts directives can be used to achieve this.

Configuration

By default, the /app/config folder contains two configuration files (development.php and production.php). You can create as many for each of your environments as needed. The application is initially configured to use the /app/config/development.php configuration file. To specify which configuration file to use, modify the /mode.php to specify which configuration file to use.

Modify the values in these files to fit your specific environment. At a minimum, you will need to ensure the following values are correct for your environment:

• app.url: Fully qualified URL to the location of the public folder (e.g. http://YOURDOMAIN OR IP/APP PATH/public)
• db: Settings for your database
• mail: Settings for your SMTP server

Security

The application allows new users to register. No functionality other than registration is available to guest users. Once registerd, users can authenticate by logging in with their credentials. By default, new users are registered without any special roles. Special roles are ADMIN, INSTRUCTOR, and ADVISOR. These can be assigned by an Administrator when creating a new user or updating an existing user's profile. All users can create submissions to active queues, track their submissions, and create comments for their submissions.

Specialize role functionality includes:

• ADMIN
  • Application wide access and functionality
  • Manage Users and Courses
• INSTRUCTOR
  • Manage queues for courses that they are assigned
  • Manage all submissions for courses that they are assigned
• ADVISOR
  • Manage personal queues that they create
  • Manage all submissions for their personal queue