User Manual. KSU Student Portal. Version 1.0. Submitted in partial fulfillment of the requirements of the degree of MSE

Transcription

1 User Manual KSU Student Portal Version 1.0 Submitted in partial fulfillment of the requirements of the degree of MSE Javier Ramos Rodríguez CIS 895 MSE Project Kansas State University

2 Table of Contents 1. Installation Overview Database Application 5 2. Operation Overview Index Page Registration Page Main Page Guess User Registered User Edit Profile Change Password Browse Items Add Item Edit Item Search Information 14 2

3 1. Installation 1.1. Overview This project consists in a Web application that was built to run on any Operation System or application server. It uses the JSF and EJB 3.0 standards. So, any Web/Application server that implements these specifications can be used to run this application. This application is also database independent. So, any DBMS can be used to run this application. Since there is no client for this project, this document will give a general guideline on how to install the application that can be useful independently on the tools used. Deploy a web application is not an easy task. Knowledge of the application server and database is required. There are many documents and manuals available for the application servers. The goal of this document is not to be a tutorial of these tools. Some of the applications servers that currently support the EJB 3.0 specification are: - Oracle OC4J. - JBoss 4.x - Sun Application Server. This project was tested using Oracle as DBMS and OC4J as application server. 3

4 1.2. Database The user needs to create the database schema using the DBMS. There is a script SQL file in the scripts folder with the SQL code necessary to create the tables in a relational database. The database must support sequences that will be used for automatic ID generation. The sequences are also included in the scripts folder: - schema.sql: Database Schema. - sequences.sql: Sequences. The user will execute the schema file first and then the sequences. The SQL code is written for Oracle databases, SQL is a standard but sometimes some DBMS differ from others, especially with the sequences. In this case, the user should take a look at the data model document and implement the schema in the corresponding database making the appropriate changes in the SQL code. 4

5 1.3. Application After creating the tables in the database we need to deploy the application is the application server. An application server includes: - A JSP container that implements the JSP/Servlet API - A EJB container that implements the EJB 3.0 Specification - A Web Server - JSF 1.2 API First of all, we need to establish the database connection. Usually the application servers have a data source configuration file that implements a connection pool. This file should be configured including the database username and password. Once the connection is configured, the application must be deployed inside the application server. Check the application server manual for more information. 5

6 2. Operation 2.1. Overview The system uses a Web browser to interact with the user. We assume that users know how to use the web browsers and how to navigate on the Internet (use menus, buttons, checkboxes ) The interface was built to make the iteration with the user very easy. The operation will be very straight forward even for amateur users. If some fields seem to be unclear there will be text that explains the user the goal of the particular field. This section will explain the basic usage of the interface focus on the parts that may be not so clear such as registration of the filter information. 6

7 2.2. Index Page The user can register in the application by entering the user name and password and clicking submit. At any time, he/she can change the language using the language menu selecting another language and clicking change. There are two links in the page, one to enter as guess to view only public information ( Guess ) and another link Register to sign in the application. 7

8 2.3. Registration Page In this page there are several fields that may be filled by the user. Only the ones that are in bold and marked with asterisk are mandatory. The user can select a state and a country using the menus or live it black by leaving the select tag. The user can select one or more languages and course. To use the multiple selection list the user must press control and select the courses that he/she is taking. The user can deselect the courses also pressing control. 8

9 2.4. Main Page Guess User The functionalities available for the guess user will be shown in the page using web links. The guess user can only see the public information Registered User The registered user will have more features than the guess user such as edit his/her profile, manage the blog and manage news, events or articles. He/she will have access to private information. 9

10 2.5. Edit Profile The edit profile page is just like the registration page but with the current information in the corresponding fields. The picture will be also shown. The user will make the appropriate changes and click submit. The user can select/deselect courses pressing control and the clicking on the menu. 10

11 2.6. Change Password The user must enter the current password and the new one. To confirm that the user enters the right password he/she has to rewrite it Browse Items When clicking on news/events or articles the system will gather the information and show it to the user in a table. In the case of a registered user the filter algorithm will be executed to get personalized information. The items created by the user will have two links to edit and remove the item. There will be a link to add the item. 11

12 2.8. Add Item In this page the item form is displayed. The user has to enter the title and choose the visibility. In the case of private items, the filter information may be introduced to choose which users should see that information. For example if a language is selected only users that have that language in their profile will see the item. If leaved blank all users will see the article independently of the language selected in the profile. The same method is used in the other fields. 12

13 2.9. Edit Item The form will be displayed with the fields properly filled with the current information. The user may change any fields and submit the information by clicking submit. 13

14 2.10. Search Information The user will enter the search string and the system will perform the search. The results will be displayed in a table. 14