TECHNICAL DOCUMENTATION

Transcription

1 TECHNICAL DOCUMENTATION OF mfmoduleappointments (Version 1.0) Developed By : Mindfire Solutions

2 CONTENTS 1. Overview 2. Project Environment 3. Plug-ins / Beans Used 4. Screen Resolution 5. Database Structure 6. Important Forms 7. Modifications Required 8. Installation Guide 9. Screen shots

3 OVERVIEW The main purpose of this application is to provide an efficient way to maintain daily appointments. User can create and manage there own appointments. It has a good, user friendly interface which makes it easier to handle the appointments. We have referred Google calendar for developing this module. This module is both Smart and Web client compatible. Internationalization is implemented for multi language support. Administrator users can set the preferences for the application. User can have multiple concurrent appointments at a particular time. The user get notified by the application before the appointment get started. The time duration before which the alerts should be fired are configurable in Settings section. Another module called mfmodulebatchprocessor is there. This module will work as a batch processor and will run in the Servoy Server as a Headless Client. This headless client periodically checks the upcoming appointments and sends notification to the respective users about their upcoming appointments. Modules : There are two modules. The first one is used to create, manage and to display the appointments. And the second one is used as the Headless client to serve notifications. 1. mfmoduleappointments 2. mfmodulebatchprocessor

4 Key points : 1. Appointments can be created by double clicking on the calendar area. It will auto populate the start and end date time of the new appointment. All the informations related to the appointment can be set over here. 2. Select any appointment by clicking on its area. 3. Both Smart and Web client support. 4. Recurrence is implemented to create multiple appointments at a time. 5. Provides notifications to users related to upcoming Appointments. 6. Context menu options are given to easily modify the appointments. 7. Edit, delete, duplicate appointment, setting priority, marking as done/undone, increasing/decreasing appointment duration, changing appointment type can be handled in the context menu. 8. You can jump to any date by selecting the date in the top left corner. 9. A navigator calendar is provided, which displays coming three months dates by default. On selecting any date the main calendar screen get refreshed by populating the appointments for that date time period. 10. The bold dates in the side navigator calendar depicts the presence of appointments on that particular date for that user. 11. Double click on any appointment to open the appointment in its editor, where you can modify the appointment details. 12. Appointment can be deleted by simply pressing DEL key after selecting the appointment. 13. All the views support drag and drop. So drag any appointment to any other cell to automatically modify the appointment's start and end date time. 14. While dragging any appointment, press CTRL key to duplicate the appointment by placing it in the desired date time cell. All these duplicated appointments are automatically related to the same master record and they are the part of the same series.

5 15. To move any appointment towards the end or beginning of the day, in day and week view, select it and press CTRL + UP / DOWN key. This will change the start and end date of the appointment automatically. 16. To increase / decrease the appointment duration in the day and week view, select the appointment and press SHIFT + UP / DOWN key. 17. Tips are being displayed at the bottom of the main calendar, when show tips is enables in the settings. 18. Press CTRL + F to show the search form for appointments. 19. Select any appointment from the search result to show it in Day view. 20. In the search criteria type any keyword, which will be matched with the Title and Location of the appointments. 21. Click on Today link to refresh the main calendar for today's date. In Day view it will open the screen for current date. In Week view it will show current week. And in Month view it will open current month. 22. Click on the Week view's header date to go to the Day view for that date. 23. Click on the New button to show the screen to add new appointment to the application. 24. Click on the left bottom Company logo to open the company site in browser. Project Environment : Technology : Java RAD Tool : Servoy Database : MySQL OS : Windows XP For web client, this module is tested in Firefox.

6 Plug-ins / Beans used : In Version-1.0 external Plug-ins are not used. Only some of the Servoy default plug-ins are used. They are. 1. Dialogs Plugin : To show the warnings, errors and Questions through out the application. 2. File Plugin : This plug-in is used to import logos/images to the application. 3. Images Plugin : Used to validate image files. 4. Mail Plugin : This is used to send notifications to the users. 5. Scheduler Plugin : This plug-in is used to create batch jobs to send appointment related notifications. 6. Window Plugin : This plug-in is used to create keyboard shortcuts. This is also used to create context menus for the appointments. No beans are used in this module. Screen Resolution : Screen resolution for mfmoduleappointments has been setup to 1440 X 1024.

7 Database Structure : This module mfmoduleappointments using one database connection: schedule Table Information : 1. mfcal_tbl_appt_masters : This table is used to store the appointment master record. It is created to relate all the appointments created in a recurrence. It uses the foreign key as user_idx and appt_type_idx from the table mfcal_tbl_appt_types. 2. mfcal_tbl_appointments : All the appointments are being stored in this table. The appointments are related to the master record by using the foreign key appt_master_idx from the mfcal_tbl_appt_masters table. 3. mfcal_tbl_appt_types : All the appointment types are managed over this table. The Administrator user can create, edit and delete the appointment type records. Each appointment type is associated with a color. This color is used to distinguish appointments of different types. The Administrator user can change/update the color codes for the appointment types. 4. tbl_preference : This is the preference table used for the application. All the preferences are managed in this table by Administrator. Administrator can set the preferences by clicking the settings link in the main application area. 5. mfcal_tbl_tips Application related tips and tricks are managed over here. The tips can be visible when the show tips is enables. The tips can be seen below to the main calendar area. 6. i18n_message This is the table for i18n message.

8 ER Diagram :

9 Important Forms : 1. mfcal_main : This is the main/first form in mfmoduleappointments module. This provides the basic design of the calendar. Code for creating the left Navigator calendar and Main Calendar is written here. The logic to show, manage, add, edit, delete appointments are done. All the calendar display views are managed here. 2. mfcal_appointments : This form is used to display the list of appointments. Mainly used to show the appointments of the Search result. 3. mfcal_newappointment : Used to Create new Appointments. Also used for Editing existing Appointments. 4. mfcal_searchappointment : This is the main form for appointment search. 5. mfcal_settingsmain : This is the main form and content holder for all the settings related forms. All the settings related forms are displayed over here in tab panel. 6. mfcal_settingsappttype : Here appointment types can be added, edited and deleted. 7. mfcal_settingsgeneral : All the General settings for the Calendar are provided over here. Settings related to alerts and notifications are provided.

10 8. mfcal_settingsnavcalendar : All the settings related to the navigator calendar are shown and managed. 9. mfcal_settingstips : Tips can be added or Modified to the application in this form. Modifications Required (Exposed methods) : This mfmoduleappointments is a generic Module, which can be attached with any Servoy application. So after attaching this module to any Servoy application, some global methods needs to be modified. Check the following methods. 1. globals.mfcal_g_isadmin : [mfmoduleappointments] This method returns true/false after checking the currently logged in user is administrator or not. Return true when the current user is administrator, else return false. 2. globals.mfcal_g_getuseridx : [mfmoduleappointments] This method is intended to return the current user's id (primary key). This user id is used to distinguish the appointments of one user from another. 3. globals.mfcal_g_getservername : [mfmoduleappointments] This method returns current database server name. The default server name is 'schedule' without quotes. If you change the server name, then return the new server name by this method.

11 4. globals.mfcal_g_getcompanywebsite : [mfmoduleappointments] This returns the current company's website address. 5. globals.mfcal_g_getusermailid(user_idx) : [mfmodulebatchprocessor] This method returns the mail id of the user whose id passed as parameter. This method is present in 'mfmodulebatchprocessor' module.

12 Installation Guide : I. Importing Solution to Servoy Developer : Open developer. Create a database connection named schedule. Right Click on All Solutions node. Select Import Solution. Select the mfmoduleappointments.servoy file in the browse box. Check the option Allow data model (database) changes. Hit Finish. Give password when asked : mindfire The same process will be repeated to import the batch processor module to the Servoy developer.

13 II. Importing Solution to Servoy Server : Make sure that the Servoy Server is started. Open Servoy Server in the browser. Click Solutions from left panel. Click Import Solution and browse the mfmoduleappointments.servoy file to import. Hit Import to start importing the solution to the server. Repeat this process for the mfmodulebatchprocessor.servoy solution.

14 III. Setting Batch processor in Servoy Server : Now you need to setup the batch processor in the server. Go to the Batch Processors Section. Select the mfmodulebatchprocessors solution from the drop down. Hit on Add button. Click Start button in the Status area of the batch processor to start the batch processor client. Restart Servoy Server.

15 Screen shots :

16

17

18 Conclusion : We hope this module will help many of the Servoy developers. We expect few issues and new feature requests. Fill free to contact us at Thank you all for your support. === O ===