User Manual of revewthedoctors
THIS BLOG claims no credit for any images posted on this site unless otherwise mentioned. Images on this blog are copyright to its respectful owners. If there is an image appearing on this blog that belongs to you and if you do not wish for it to appear on this site, please drop an email at smriita@gmail.com and it will be promptly removed.
‘revewthedoctors’ is a non profit project and is in the initial phase of its development and so claims no credit for any images used on the web application unless otherwise mentioned. Images on web application have been downloaded from google and are copyright to their respectful owners. If there is an image appearing on the project that belongs to you and if you do not wish for it to be used on the web application, please drop an email at smriita@gmail.com and it will be promptly removed.
**The word specialty has been used incorrectly through out the application with a wrong spelling : speciality. The spelling will be corrected in coming up phases of development.Similarly the incorrect spelling has been used extensively in this blog aswell.
‘revewthedoctors’ is a web application built using JAVA EE and spring framework. This blog post serves as a guide that helps in navigating across the application.
NOTE
A variable ‘appurl’ will be used to denote all URLs where
appurl= server:port/contextpath
For instance, when the application is deployed to a local tomcat server the URL becomes : http://localhost:8080/revewthedoctors
Also many pages across the application have same urls however they are accessible with the help of tabs. Hence urls will be mentioned along with their tabs. Following convention shall be used to denote a URL + the corresponding tab.
appurl/pageurl [tabname]
- Login Page
url :appurl/home [LOGIN]
This is the login page. Users can login using their username and password.
2.Signup page:
url :appurl/home [SIGNUP]
Users can signup in this web application through signup page.
There are two kinds of users in the application namely admin and user. These users have different dashboards.
Admin Dashboard
The dashboard helps admin create different entities namely Country, Zone,District,City , User , Hospital,Speciality , Doctor and Review.
There are two tabs in the entire admin dashboard. The create tab displays forms to create entities whereas the list tab displays a table that shows a list of entities saved .
Country
Create Country
URL: appurl/admin/country [CREATE]
Success Message
Admin should provide name of the country and save it. Upon successful addition the following message appears
URL: appurl/admin/country [CREATE]
Error Message
Duplicate entries cannot be saved and if such an attempt is made an error message is displayed. Similarly if an entity cannot be saved because of some other reasons then similar error message is shown.
URL: appurl/admin/country [CREATE]
List Countries
Shows a list of countries that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/country [LIST]
Create Zone
This form lets admin create zones. The fields in this form are described below
Zone Name : Name of a zone
Country :Country that a zone belongs to.
URL: appurl/admin/zone [CREATE]
Message after saving a zone successfully:
URL: appurl/admin/zone [CREATE]
Error message if a zone cannot be saved:
URL: appurl/admin/zone [CREATE]
List Zones
Shows a list of zones that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/zone [LIST]
Create District
This form lets admins add districts.The fields in the form are described below:
District Name: The name of the district.
Zone : The name of the zone that the district belongs to.
URL: appurl/admin/district [CREATE]
Message after saving a district successfully:
URL: appurl/admin/district [CREATE]
Message incase a district cannot be saved:
URL: appurl/admin/country [CREATE]
List District
Shows a list of districts that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/country [LIST]
Create City
This form lets admins add cities.The fields in the form are described below:
City Name: The name of the city.
District : The name of the district that the city belongs to
URL: appurl/admin/city [CREATE]
Message after saving a city successfully:
URL: appurl/admin/city [CREATE]
Message incase a city cannot be saved:
URL: appurl/admin/city [CREATE]
List City
Shows a list of cities that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/city [LIST]
Create User
This form lets admins add countries.The fields in the form are described below:
First Name : First name of the user.
Middle Name: Middle name of the user.
Last Name: Last name of the user.
Email: Email of the user.
Password: Password of the user.
City: City that the user belongs to.
URL: appurl/admin/user [CREATE]
Message after saving a user successfully:
URL: appurl/admin/city [CREATE]
Message in case a user cannot be saved:
URL: appurl/admin/city [CREATE]
List User
Shows a list of users that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/city [LIST]
Create Hospital
This form lets admins add hospitals.The fields in the form are described below:
Hospital Name: The name of the hospital.
Type: The type of the hospital (for instance Heart hospital or neuro hospital etc)
City:The city that the hospital belongs to.
URL: appurl/admin/hospital [CREATE]
Message after saving a hospital successfully:
URL: appurl/admin/hospital [CREATE]
Message in case a hospital cannot be saved:
URL: appurl/admin/hospital [CREATE]
List Hospital
Shows a list of hospitals that have been saved. The edit and delete buttons do not work for the first phase of the application.
Create **Speciality
This form lets admins add specialties. The fields in the form are described below:
Specialty name: The name of the specialty such as Pulmonologist.
Category: The category of the specialty such as chest.
URL: appurl/admin/speciality [CREATE]
Message after saving a specialty successfully:
URL: appurl/admin/speciality [CREATE]
Message incase a **Speciality cannot be saved:
URL: appurl/admin/speciality [CREATE]
List **Speciality
Shows a list of specialities that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/speciality [LIST]
Create Doctor
This form lets admins add doctors.The fields in the form are described below:
First Name: First name of the doctor.
Middle Name:Middle name of the doctor.
Last Name : Last name of the doctor.
Email: Email of the doctor.
Hospital:Hospital that the doctor works in.Its a multi select list from which more than one hospital can be selected.
**Speciality: Specialty of the doctor.Its a multi select list from which more than one specialty can be selected.
URL: appurl/admin/doctor [CREATE]
Message after saving a doctor successfully:
URL: appurl/admin/doctor [CREATE]
Similarly an error message is shown whenever a doctor cannot be saved.
List Doctor
Shows a list of doctors that have been saved. The edit and delete buttons do not work for the first phase of the application.
URL: appurl/admin/doctor [LIST]
Create Review
This form lets admins add reviews on behalf of users.The fields in the form are described below:
Doctor: This combo box lets admin select the doctor for whom the review is to be created.
User :As admins can make reviews on behalf of users , this combo box lets admins choose a particular user.
Review: The review of the doctor.
Rating: The rating of the doctor.
URL: appurl/admin/review [CREATE]
Message after saving a review is saved successfully:
URL: appurl/admin/review [CREATE]
Similarly an error message is shown whenever a review cannot be saved.
List Reviews
Shows a list of reviews that have been saved. The edit and delete buttons do not work for the first phase of the application.
The review column if is clicked then the user can view an individual review.
URL: appurl/admin/review [LIST]
Individual Review
The details of the review can be viewed from this page. In this page the menu is hidden . However if the slide in menu opener is clicked then the menu appears.
URL: appurl/admin/individualreview?reviewId=<reviewId>
Slide in menu opener
Slide in menu
Individual Doctor
The details of a doctor can be viewed from any individual review page by clicking on the doctors name. The picture that has been used here is a dummy picture as picture upload functionality has not been implemented as of now. All reviews related to a doctor is listed in this page .Similarly a review can be viewed by clicking ‘View’ button which will redirect the user to individual review page. This page has slide in menu just like the individual review page.
URL: appurl/admin/individualdoctor?doctorId=<doctorId>
USER DASHBOARD
Search Page
URL: appurl/reviewer/search
Users can search either doctors or review. Whenever any user selects the doctor radio and presses search icon, doctors related to that search query is returned .Similarly whenever any user selects a review radio and presses search icon, reviews related to that search query is returned.
The tags that are below the search bar are not workable as of now.
But the radio buttons ‘Doctor’ and ‘Review’ work.
Search by doctor
Search Criteria: Users can search doctors by doctor’s first name, doctor’s middle name, doctor’s lastname and doctor’s specialty name.
URL: appurl/reviewer/search
- Doctor Radio is selected.
- Name of the doctor is typed
- Search button is pressed after which the following page is returned.
Search Result
URL: appurl/reviewer/searches
Users can view the details of the doctor by clicking on the doctor’s name
Individual Doctor
URL: appurl/reviewer/individualdoctor?doctorId=<doctorId>
Individual Doctor page for admin and users are same apart from the slide in menus and the tabs. The picture that has been used is a dummy picture. Reviews related to a doctor is shown and user has the privilege to view each review
In case no result is found the following message is returned.
URL: appurl/reviewer/searches
Search by review
Search Criteria: Users can search reviews by reviews, doctor’s first name, doctor’s middle name, doctor’s lastname and doctor’s speciality name.
URL: appurl/reviewer/search
- Review Radio is selected.
- Name of the review is typed
- Search button is pressed after which the following page is returned.
Search Result
URL: appurl/reviewer/searches
Users can view the details of the review by clicking on any review.
Individual Review
URL: appurl/reviewer/individualreview?reviewId=<reviewId>
Individual Review page for admin and users are same apart from the slide in menus and the tabs. The picture that has been used is a dummy picture. Reviews related to a doctor is shown and user has the privilege to view each review
In case no result is found the following message is returned.
URL: appurl/reviewer/searches
Review Feed
URL: appurl/reviewer/reviewfeed
Users can see a collection of latest reviews in this page.
If no reviews are there in the system following warning message is shown.
URL: appurl/reviewer/reviewfeed
Make A Review
URL: appurl/reviewer/makeareview
Users can make review of any doctor and rate her/him aswell. This page needs to be designed properly which will be done in next phase of the application development.
Slide In Menu
Profile
URL: appurl/reviewer/profile
Users can view her/his profile. The picture that has been used is a dummy one.
My Reviews
URL: appurl/reviewer/myreviews
Users can view the reviews that they have made in this page. The difference between Review feed and this page is the fact that this page lists the reviews made by the current logged in user where as review feed page lists all the reviews made by any user in the system.
In case no review is found following error message is shown.
URL: appurl/reviewer/myreviews
