DB DAL BLL WS. Server. Click2Go Web Site. Mobile Phone. Click2Go Mobile Application. System's Architecture. System Overview

Size: px

Start display at page:

Download "DB DAL BLL WS. Server. Click2Go Web Site. Mobile Phone. Click2Go Mobile Application. System's Architecture. System Overview"

Lesley Melton
6 years ago
Views:

1 System's Architecture System Overview Server Click2Go Web Site DB DAL BLL WS Mobile Internet Connection (GPRS, UMTS, WLAN, ) Mobile Phone Click2Go Mobile Application The system contains two environments: Server and Mobile Phone. The Server contains the following layers: DB Database : the database of the system. DAL Data Access Layer : provides simplified access methods to the DB. BLL Business Logic Layer : provides data processing methods. WS Web Service : provides simplified interface to access the BLL methods from any application. Click2Go Website contains lecturer's and administrator's user interfaces. Can be accessed from any web browser. The Mobile Phone contains the Click2Go Mobile Application student's user interface. It can be accessed from any mobile device that supports J2ME applications. The system parts are written in the following languages: DB SQL environment: VS.NET 2008 DAL, BLL, WS C# environment: VS.NET 2008 Click2Go Web Site ASP.NET, C# environment: VS.NET 2008 Click2Go Mobile Application J2ME (JAVA) environment: NetBeans J2ME

2 DB Database The database that included in system is a SQL Server (or SQL Express Server) database. The database contains 8 tables as following: Answer Course Lecturer Question RegisteredStudent Setting Student StudentAnswer WS BLL DAL DB Tables Structure Answer * Contains all the answers that are stored in the system. Each answer contains an identifier (auto-generated by the database), the id of the connected question, the text of the answer and a flag that indicates the correctness of the answer. Course Contains all the courses that are stored in the system. Each course contains its own identifier (created randomly in the server application), its name and the identifier of the course's lecturer. Lecturer

The lecturers are the users of the system's web site. Each lecturer has its own unique id, login password, and additional information like first name and last name.

3 The lecturers are the users of the system's web site. Each lecturer has its own unique id, login password, and additional information like first name and last name. The is used to reset lecturer's password, if he forgets it. Question * The question table contains all the questions that are stored in the system. Each question has its own identifier (that is generated automatically by the database), the course id (all the students of this specific course will see the question), the question text, a flag that indicated whenever this is a open question or a multiple choice question, a flag that indicates if the answer to this question is numeric or not necessarily, the time (in seconds) that the question will be activated after activating it, the date of the question creation, the date of the question activation, and the date of the question deactivation. RegisteredStudent * This table connects between each student to the courses that he is registered to. The registration id is a auto generated identifier. Setting The setting table contains all the important settings of the system. The basic settings will be the administrator's user name, and his password. Each record will contain a setting name (for example "AdminUser" or "AdminPass"), and it's value (for example, the "AdminUser" will be "admin"). Student

The e- mail is used to reset student's password if he forgets it. StudentAnswer * This table connects between students and their answers.

4 The students are the users of the mobile application. It's student will have its own unique id identifier, login password, and additional information like first name and last name. The e- mail is used to reset student's password if he forgets it. StudentAnswer * This table connects between students and their answers. Each record will have a auto generated identifier, a student id (the student that answered to the question), the answer id (student's answer), and the date of answering the question. * Auto generated identifier when creating a new row, it is not necessary to provide the id because the database defines the id automatically.

5 Relationships Diagram

DAL Data Access Layer "A Data Access Layer (DAL) is a layer of a computer program which provides simplified access to data stored in persistent storage of some kind, such as an entity-relational

7 DAL Data Access Layer "A Data Access Layer (DAL) is a layer of a computer program which provides simplified access to data stored in persistent storage of some kind, such as an entity-relational database. This data access layer is used in turn by other program modules to access and manipulate the data within the data store without having to deal with the complexities inherent in this access." WS BLL DAL DB Wikipedia The DAL at the Click2Go system is a class library that contains the following classes: SqlDAL.cs - This class includes all the common methods in database programming in.net methods. This is the lowest layer of communicating with the database. AnswerDAL.cs Includes all the SQL methods that are used by the system at the "Answer" table. CourseDAL.cs The same for the "Course" table. LecturerDAL.cs - The same for the "Lecturer" table. QuestionDAL.cs - The same for the "Question" table. RegisteredStudentDAL.cs - The same for the "RegiseredStudent" table. SettingDAL.cs - The same for the "Setting" table. StudentDAL.cs - The same for the "Student" table. StudentAnswerDAL.cs - The same for the "StudentAnswer" table. You can browse the class files themselves for more specific details about the methods. Compiling DAL After changing the DAL you should compile the class library and to create a new *.dll file. The following explanation will be based on the Visual Studio.Net 2008 environment. 1. Click on "Build" at the standard toolbar 2. Click on "Batch Build " 3. On the "Build" column, tick the two boxes as shown on the following picture:

$4. Click on "Build". That's it! The New.dll file will be created at DAL\bin\Release folder.$

8 4. Click on "Build". That's it! The New.dll file will be created at DAL\bin\Release folder. Important: after compiling DAL it is necessary to compile all the layers that above the DAL: Compiling BLL Compiling and Publishing WS

BLL Business Logic Layer The Business Logic Layer (BLL) contains the functional algorithms that handle information exchange between a database and a user interface.

9 BLL Business Logic Layer The Business Logic Layer (BLL) contains the functional algorithms that handle information exchange between a database and a user interface. WS BLL DAL The BLL at the Click2Go system is a class library that contains the following classes: DB BLL.cs - This class includes some "global" methods that are table-independed. AnswerBLL.cs Includes all the functional algorithms that are used by the system at the "Answer" table. CourseBLL.cs The same for the "Course" table. LecturerBLL.cs - The same for the "Lecturer" table. QuestionBLL.cs - The same for the "Question" table. RegisteredStudentBLL.cs - The same for the "RegiseredStudent" table. SettingBLL.cs - The same for the "Setting" table. StudentBLL.cs - The same for the "Student" table. StudentAnswerBLL.cs - The same for the "StudentAnswer" table. You can browse the class files themselves for more specific details about the methods. Note: In the BLL you will see some functions that only take a DataTable from the DAL, puts it into a DataSet, and returns the DataSet. The reason for doing it is that the upper layer (the Web Service) cannot return a DataTable. Compiling BLL After changing the BLL you should compile the class library and to create a new *.dll file. The following explanation will be based on the Visual Studio.Net 2008 environment. The BLL compiling method is the same as the Compiling DAL method. Quick Reference: Important: after compiling BLL it is necessary to compile all the layers that above the BLL: 1. Compiling and Publishing WS

11 WS Web Service "The Web Service (WS) is frequently just Internet Application Programming Interfaces (API) that can be accessed over a network, such as the Internet, and executed on a remote system hosting the requested services." Using the Web Service, each programmer can use the functionality that provided by the system in his application, and include it in his application. WS BLL DAL DB The Web Service can be accessed by a Windows Application, by an ASP Website, by a mobile application, The WS at the Click2Go system is a class library that contains the following classes: AnswerWS.cs Includes all the functional algorithms that are physically called by the system at the "Answer" table. CourseWS.cs The same for the "Course" table. LecturerWS.cs - The same for the "Lecturer" table. QuestionWS.cs - The same for the "Question" table. RegisteredStudentWS.cs - The same for the "RegiseredStudent" table. SettingWS.cs - The same for the "Setting" table. StudentWS.cs - The same for the "Student" table. StudentAnswerWS.cs - The same for the "StudentAnswer" table. Important: Because of the development environment constraints, there is a limited collection of data type that can be returned by the Web Service functions. Some of the constraints are: 1. Web service's methods cannot return DataTables. Solution: at the BLL section, in each function that should return a DataTable, convert the DataTable to a DataSet by using the following code: DataTable dt = new DataTable(); DataSet ds = new DataSet; ds.table.add(dt); return ds; 2. The mobile application cannot interact with web service's method that return DataSets. Solution: if you can convert the returned data type to an array (int[], long[], ) it is the best. There is no other solution for the functions that the mobile application should use. If the function not being used by the mobile application, you should compile and publish the web service (see: Compiling and Publishing WS) without the functions that are not being used by the mobile application (you can put them on comments), update the web services packages at the mobile application (see: ) and then publish the full web service. By this, the mobile application will not see the functions that are not necessary for it. Compiling and Publishing WS // the returned DataTable

After changing the WS you should compile it and publish it to the server. The following explanation will be based on the Visual Studio.Net 2008 environment.

Then, you should create a pre-published directory that will contain all the data that will be uploaded to the server. Click on "Build" at the standard toolbar, and click on the "Publish WS" option.

12 After changing the WS you should compile it and publish it to the server. The following explanation will be based on the Visual Studio.Net 2008 environment. To compile the Web Service, click on "Build" at the standard toolbar, and click on the "Build WS" option. Then, you should create a pre-published directory that will contain all the data that will be uploaded to the server. Click on "Build" at the standard toolbar, and click on the "Publish WS" option. Important: see the "System Administrator Guide" for setting the connection to the database before uploading the web service. Now, you should specify a target directory (of the pre-published directory). All the files will be created at the specified directory, after clicking on "Publish". At the target location will be created bin and App_data folders, Web.config file, and a collection of *.asmx files. Now, connect to the FTP server, and go to the /WS/ folder. Upload to this folder all the contents except the bin folder. Then, go to the /bin/ folder in the server and upload to it all the contents of the bin folder at the pre-published directory.

Click2Go Website The Click2Go Website is the lecturer's and administrator's interfaces in the Click2Go system. The website is an ASP.NET website that has been created at Microsoft Visual Studio.

14 Click2Go Website The Click2Go Website is the lecturer's and administrator's interfaces in the Click2Go system. The website is an ASP.NET website that has been created at Microsoft Visual Studio.NET 2008 environment. The website contains the following files and directories: Directories: Admin the administrator control panel and pages App_Code important classes that are used by the website App_WebReferences the references to the Web Service Images the images that are used in the site Main directory contains all the pages of the main lecturer's site Updating Web References If you have updated your web service by adding new methods or by changing the title (name of the method, returned data type, arguments) of existed methods, you need to update the web reference to the web service in your site. The following explanation will be based on the Visual Studio.Net 2008 environment.

Follow the steps below, and use the following examples to avoid mistakes. Let's use the following example: suppose that the web service "AnswerService" have been updated on the server. 1.

discomap" (our example) reference and click on "Remove Web Reference". 2.

15 Follow the steps below, and use the following examples to avoid mistakes. Let's use the following example: suppose that the web service "AnswerService" have been updated on the server. 1. Delete the web reference of the updated web service In the Solution Explorer, go to the "App_WebReferences" folder, and then go to the "WR" folder. Right-click on the "AnswerService.discomap" (our example) reference and click on "Remove Web Reference". 2. Add the updated web reference Right-click on the "App_WebReferences", and click on "Add Web Reference" In the URL section type the URL of the web service. For example: And click on "Go". In the "Web Service Name" type: "WR" (without the inverted commas), and click on the "Add Reference" button. You'll see that the selected web service will appear again in the WR folder. 3. Change the URL to a global URL Now, you need to make the web.config file to the "Header" of the web service file. This is done by changing the web service URL at the following files: AnswerService.discomap, AnswerService.disco, AnswerService.wsdl, to the fillowing URL: All you need to do is to find all phases of the web service URL ( in the specified files, and change them to the new URL. Compiling and Publishing Website After changing the website, we need to compile it and publish it to the server. The following explanation will be based on the Visual Studio.Net 2008 environment. The compiling and publishing methods are similar to the compiling and publishing methods at the WS (see: Compiling and Publishing WS).

Important: see the "System Administrator Guide" for setting the

Now, at the pre-published folder you'll see the following files and

Upload to the main directory at the FTP server all the files and

Navigate to the /bin folder at the server, and delete all the files

16 Important: see the "System Administrator Guide" for setting the connection to the web service before uploading the site. Now, at the pre-published folder you'll see the following files and folders: The uploading method is the following: 1. Upload to the main directory at the FTP server all the files and folders except the bin folder. 2. Navigate to the /bin folder at the server, and delete all the files that their names start with "App_Web". 3. Upload all the contents at the bin folder in the pre-published folder to the bin folder in the server.

17 Click2Go Mobile Application The Click2Go Mobile Application is the student's interface in the Click2Go system. The application was built in NetBeans J2ME environment, the Web Reference was imported using Sun Java (TM) Wireless Toolkit for CLDC, and the styling (theme, localization, images) with the Lwuit Resource Editor. Packages The Click2Go Mobile contains the following packages: <default package>: contains the styling resource, and the images. Click2GoMIDlet: contains the Click2Go.java MIDlet class, with all the forms, and methods. MD5Converter: this is a open-source class that is useful for encoding text by the MD5 encoding system. mypackage: classes that the system been using. Studentservice, answerservice, courseservice, questionservice, registeredstudentservice, settingsservice, studentanswerservce : the web references to the web services (autogenerated). LWUIT The Click2Go Mobile Application uses LWUIT. LWUIT is a UI library that is bundled together with applications and helps content developers in creating compelling and consistent Java ME applications. LWUIT supports visual components and other UI goodies such as theming, transitions, animation and more. For more details, visit LWUIT web sites, blogs, and tutorials: - Tutorial: - Blog: - Web Site: - Forum: RMS Record Management Store The Click2Go Mobile Application uses the RMS storing data mechanism for saving settings and user information on the mobile phone. For more details, visit the following web site: MIDlet Overview The MIDlet has the following forms: Login form Reset password form Registration form Courses form Registration to course form

18 Questions form Answers form Settings form Change password form About form "Loading" ("Please wait") form And the following dialogs: Error dialog Message dialog Each form or dialog has its own function that creates it, updates it, or shows it. We will demonstrate the functions in the 2 main forms: Login The login method contains two functions: ShowLoginUser Initializes and shows the login user form CheckSavedLogin Checks if the RMS has user information, if does checks the user information in the server. If the check was successful the software moves directly to the courses list without login needed. Questions The questions method contains two main functions: ShowQuestions Initializes and shows the questions form FillQuestionForm Updating the questions list with the server. This function called each time "Refresh" command is executed. For more detailed description see the comments in the code

Application Flow Overview The following activity diagram shows the flow of the program run, starting at program's startup, through registration to the system, until sending an answer to a question.

19 Application Flow Overview The following activity diagram shows the flow of the program run, starting at program's startup, through registration to the system, until sending an answer to a question. Updating Web References If you have updated your web service by adding new methods or by changing the title (name of the method, returned data type, arguments) of existed methods, you need to update the web reference to the web service in the mobile application. The following explanation will be based on the NetBeans and Sun Java (TM) Wireless Toolkit for CLDC environments. Follow the steps below, and use the following examples to avoid mistakes. Let's use the following example: suppose that the web service "AnswerService" have been updated on the server.

1. Open the Utilities of the Sun Java (TM) Wireless Toolkit for CLDC 2.

Fill the WSDL URL in the first box, and the source folder path in the project folder at the

$ws And in the Output Path we will fill, for example: C;\Click2Go\Mobile\src 4.$

20 1. Open the Utilities of the Sun Java (TM) Wireless Toolkit for CLDC 2. Select the "Stub Generator" 3. Fill the WSDL URL in the first box, and the source folder path in the project folder at the output path. In our example, we will fill the box with the following URL: And in the Output Path we will fill, for example: C;\Click2Go\Mobile\src 4. In the Output Package fill the web service name in one word In our example, we will fill "answerservice". 5. Click "OK" and follow the steps 2-5 for the next updated web service.

21 6. Open "NetBeans" application. 7. Go to the file %ServiceName%Soap_Stub.java in each updated package In our example, go to the answerservice package, and then go to the AnswerServiceSoap_Stub.java file 8. Replace in each of those files the web service address in the following text: Server.address + "/%ServiceName%.asmx" In our example, replace to Server.address + "/AnswerService.asmx". 9. Add to each of those files the following header: " import mypackage.server;" That's It! Compiling and Publishing Mobile Application To compile the application click on F11 on your keyboard. The compiled JAD and JAR files will be located on your mobile application project folder, in the dist folder.

Installing Click2Go Mobile There are two options to install the Click2Go Mobile application on your mobile phone.

Installing Click2Go Mobile There are two options to install the Click2Go Mobile application on your mobile phone. Mobile Application User Guide Minimum Phone Requirements Java Enabled (J2ME) Phone Profile/MIDP2.0 Configuration/CLDC1.1 Screen Resolution: 128 x 96 and above Internet Connection: (one of the listed) o