├── .gitignore ├── img ├── DB_Design.png ├── actors_flow.png ├── state_digram.png ├── DB_ERD_Details.png ├── sequence_digram.png └── request_validation_flow.png ├── Object_Oriented_Analysis_Mentorship_Program.png ├── .idea └── .gitignore ├── psuedo code.txt ├── LICENSE └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/extensions.json 2 | -------------------------------------------------------------------------------- /img/DB_Design.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/img/DB_Design.png -------------------------------------------------------------------------------- /img/actors_flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/img/actors_flow.png -------------------------------------------------------------------------------- /img/state_digram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/img/state_digram.png -------------------------------------------------------------------------------- /img/DB_ERD_Details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/img/DB_ERD_Details.png -------------------------------------------------------------------------------- /img/sequence_digram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/img/sequence_digram.png -------------------------------------------------------------------------------- /img/request_validation_flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/img/request_validation_flow.png -------------------------------------------------------------------------------- /Object_Oriented_Analysis_Mentorship_Program.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/abdallahalseddek/Vacation-Tracking-System/HEAD/Object_Oriented_Analysis_Mentorship_Program.png -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Editor-based HTTP Client requests 5 | /httpRequests/ 6 | # Datasource local storage ignored files 7 | /dataSources/ 8 | /dataSources.local.xml 9 | -------------------------------------------------------------------------------- /psuedo code.txt: -------------------------------------------------------------------------------- 1 | #Create a new Vacation Request Use Case# 2 | 3 | function homePage(employee): 4 | if isEmployeeAuthenticated(employee): 5 | if isEmployeeAuthorizedAsManger(employee): 6 | listAllPendingRequestsAuthorizedToThisManager(). 7 | else: 8 | return employee_balance. 9 | 10 | function newRequest(employee, start_date, end_date, category_name): 11 | if isEmployeeValid(employee) and if isValidDateRange(start_date, end_date) and if isValidCategory(category_name): 12 | if isEmployeeBalanceIsSufficient(employee, start_date, end_date, category_name): 13 | vacationRequest = createVacationRequest(employee, start_date, end_date, category_name) 14 | updateVacationRequestStatusToPending(vacationRequest) 15 | sendEmailToManagerAndAddRequestToManagerPendingList(vacationRequest) 16 | return "Vacation request submitted and pending approval." 17 | else : 18 | return : "Insufficient vacation balance." 19 | else : 20 | return : "Invalid input data" 21 | redisplayedRequestPageWithErrorsHighlighted(); 22 | 23 | function vacationResponse(vacationRequest): 24 | if ManagerIsAuthorizedToResponseToThisManagerRequest(manager_credentials, vacation_request): 25 | if ManagerApprovesRequest(vacation_request.employee, vacation_request.start_date, vacation_request.end_date): 26 | updateRequestStatusAsApproved(vacation_request.Status) 27 | else : 28 | updateRequestStatusAsRejected(vacation_request.Status) 29 | RejectExplanationMessage(message) 30 | sendEmailToEmployeeByUpdatedStatus(vacation_request) 31 | else : 32 | return : "you are not authorized" 33 | ======================================================================================== 34 | #cancel an approved request# 35 | 36 | function cancelApprovedRequest(employee): 37 | if isValidEmployee(employee): 38 | showVacationRequestsSummary(employee) 39 | chooseRequestToCancel() 40 | if chosenRequestInFuture(vacation_request): 41 | return : "confirm the cancellation" 42 | else : 43 | shortMessageExplanation(message). 44 | return : "confirm the cancellation" 45 | if employeeApproveCancellation(vacation_request): 46 | updateRequestStatusToCancel(vacation_request). 47 | NotifyManagerByEmail(vacation_request). 48 | returnVacationTimeToEmployeeRequest(employee, vacation_request). 49 | displayHomePageWithUpdatedRequestsStatus(employee). 50 | else : 51 | effectNoChangesToCurrentRequests() 52 | 53 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vacation Tracking System 2 | ### The Vacation Sysytem Idea is presented in the [Object Oriented Analysis And Design textbook, 3rd edition](https://www.oreilly.com/library/view/object-oriented-analysis-and/9780201895513/). I worked on designing the system workflow and defining its use cases in detail including Flow diagrams, State diagrams, and ERD diagrams. 3 | ## Index 4 | - [System Features](#system-features) 5 | - [All Possible Use Cases](#use-cases) 6 | - [Manage Time Use Case Details](#manage-time-use-case) 7 | - [Database Design & Implementation ](#high-level-database-design-for-the-system) 8 | - [Flow Diagrams](#flow-diagrams) 9 | - [State Diagram](#state-diagram) 10 | - [Sequence Diagram ](#sequence-diagram) 11 | - [Pseudo Code in plain text](/psuedo%20code.txt) 12 | - [The Tools which I used In the project](#tools) 13 | 14 | ## System goal: The system has the potential to save time and money mostly in the HR department 15 | > We will take the rules from the Human Resources department, and establish a system based on them, and the HR employee will be responsible for entering and updating the employees' vacation times and dates in the system 16 | ## System features 17 | 1. Implementation of flexible rules for validating and verifying leave time requests. 18 | 2. Enable manager approval. 19 | 3. Provide access for the previous 12 months and the next 6 Months. 20 | 4. Use email notification to notify the manager when a new request and the employee after response. 21 | 5. Enable the HR and System Admin to override all actions restricted by rules by logging those overrides. 22 | 6. Allow managers to award personal leave time with system limits directly. 23 | 7. provide a UI to give the employee a vacation request summary. 24 | 25 | ### Use Cases 26 | 27 | - [x] Manage Time [create new Request, Edit pending request, withdraw request, cancel Approved Request] 28 | - [ ] Award Time 29 | - [ ] Edit Employee Record 30 | - [ ] Manage Locations 31 | - [ ] Manage Leave categories 32 | - [ ] Override Leave records 33 | - [ ] Backup system Logs 34 | 35 | 36 | ### Use Case Actors: 37 | 1. Employee 38 | 1. manage time 39 | 2. Manager 40 | 1. Approve or refuse Request 41 | 2. Award time 42 | 3. HR Clerk 43 | 1. Edit Employee Records 44 | 2. Manage Locations 45 | 3. Manage leave Categories 46 | 4. Override Leave Records 47 | 4. System Admin 48 | 1. Back-Up System Logs 49 | 50 | 51 | 52 | ## Manage Time Use Case 53 | ### Main flow: 54 | #### **preconditions**: The employee is authenticated to access the vacation System with privileges to manage his vacation dashboard 55 | 1. The employee clicks on the link to access the vacation system. 56 | 2. The system uses Employee credentials to look up the current status of the employee's previous 12M and the next 6 months' vacations 57 | 3. The employee chooses to create a new vacation request. 58 | 4. The system asks the employee which data and time he wanted for the vacation 59 | > The employee should have access to a **visual calendar** to help select and compare chosen dates. 60 | 5. The employee selects the desired dates and hours per data with a short title and description. Then submit the request. 61 | 6. If the submitted information is incomplete or incorrect or doesn't pass the validation, the app displays the request again with errors highlighted and documented 62 | 7. At this point, the employee can edit any info or cancel the request and remove all info. 63 | 8. if the request is submitted: 64 | * The employee is returned to the homepage which contains a vacation request summary. 65 | * If the employee’s vacation time requests require manager approval, an e-mail is immediately sent to the manager(s) authorized to approve the employee’s requests. 66 | 9. The request status should be updated to **pending**. 67 | 10. The manager responds to the e-mail by clicking on a link embedded in the e-mail or by explicitly logging into the System 68 | 11. The manager may be required to supply the necessary authentication credentials to gain access 69 | 12. The System home page lists the manager’s own vacation time requests and outstanding balances but also has a separate section listing requests pending approval by subordinate employees The manager selects each of these one at a time to individually approve or deny. 70 | 71 |

72 | 73 |

74 |

A Communication Diagram Describing a Request Validation Collaborationt

75 | 76 | ### High-level Database Design for the system: 77 | * Employee Table:[ EmployeeID (PK), FirstName, LastName, Email, Password, Role (Employee, Manager, HR Clerk, System Admin) ] 78 | * Manager Table: [ ManagerID (PK), EmployeeID (FK) ] 79 | * HR Clerk Table:[ HRClerkID (PK), EmployeeID (FK) ] 80 | * LeaveCategory Table:[ CategoryID (PK), CategoryName, Description ] 81 | * Location Table: [ LocationID (PK), LocationName, Description ] 82 | * VacationRequest Table:[RequestID (PK), EmployeeID (FK), CategoryID (FK), LocationID (FK), StartDate, EndDate, StartTime, EndTime, Title, Description, Status (Pending, Approved, Denied), ManagerID (FK) ] 83 | * OverrideLog Table: [ LogID (PK), Action (e.g., Edit Employee Record, Override Leave Record), EmployeeID (FK), Timestamp, Description ] 84 | * SystemLog Table: [LogID (PK), Action (e.g., Backup System Logs), AdminID (FK referencing Employee Table), Timestamp, Description ] 85 | 86 |

87 | 88 |

89 |

Data-Base Digram

90 | 91 | #### Now, let's explain how these tables are used in the context of the system's use cases: 92 | * The Employee Table stores employee information, including their roles (Employee, Manager, HR Clerk, System Admin). 93 | * The Manager Table and HR Clerk Table establish relationships between employees and their respective roles. 94 | * The LeaveCategory Table stores information about different leave categories (e.g., vacation, personal leave). 95 | * The Location Table stores information about different locations for vacation. 96 | * The VacationRequest Table is the core table for tracking vacation requests. It includes details about the request, such as start and end dates, times, and status. It also references the employee making the request and, if applicable, the manager who approved it. 97 | * The OverrideLog Table logs any actions where HR or System Admin overrides leave records. 98 | * The SystemLog Table logs system-level actions like backups performed by the System Admin. 99 | 100 |

101 |

102 | 103 | 104 | ## Flow Diagrams 105 | > Here is the Flow Digrams for the Main Flow and the other alternative flows 106 | 107 |

108 |

109 |

System Actors Flow

110 | 111 | ## State Diagram 112 | 113 |

114 |

115 |

State Machine Diagram

116 | 117 | 118 | ## Sequence Diagram 119 | 120 |

121 |

122 |

Sequence Diagram for the Main and alternative Flows

123 | 124 | 125 | If you want to access a good recap overview of what 126 | I learned in my Object-Oriented-Design journey with the book and my mentor advices, 127 | I posted [here](Object_Oriented_Analysis_Mentorship_Program.png) a one flow chart page containing all of my learning 128 | ## Tools 129 | - [Visual Studio Code](https://code.visualstudio.com/) 130 | - [Plant UML](https://plantuml.com/) 131 | - [Excali Draw](https://excalidraw.com/) 132 | - [DB Diagram](https://dbdiagram.io/) 133 | --------------------------------------------------------------------------------