E-platform for School Development & Accountability (ESDA)

Transcription

1 . E-platform for School Development & Accountability (ESDA) Administrator Manual June 2008 Page 1

2 Table of Contents ABOUT THIS MANUAL... 3 CHAPTER 1 : QUICK INSTALLATION OF ESDA ON WINDOWS SERVER PRE-INSTALLATION CHECKLIST INSTALLATION OF ESDA POST INSTALLATION CHECKLIST CUSTOMIZATION CHAPTER 2 : SYSTEM UPGRADING PROCEDURES FOR ESDA UPGRADING ESDA FOR WINDOWS PLATFORM CHAPTER 3 : ADMINISTRATIVE PROCEDURES GENERAL ADMINISTRATIVE TASKS USER GROUP AND ACCOUNT ADMINISTRATION BACKUP AND RECOVERY PROBLEMS AND DIAGNOSES CHAPTER 4 : SUGGESTED SCHEDULED TASKS UPGRADE ESDA TO THE LATEST VERSION START A NEW SCHOOL YEAR IMPORT STAKEHOLDER SURVEY PACKAGE APPENDIX 1 - INSTALLATION OF ESDA ON FEDORA LINUX APPENDIX 2 INSTALLATION OF ESDA ON OTHER WINDOWS PLATFORMS APPENDIX 3 ESDA FILE STRUCTURES AND SOFTWARE COMPONENTS APPENDIX 4 UNINSTALLING ESDA APPENDIX 5 INSTALLING ESDA ON WINDOWS SYSTEM RUNNING IIS APPENDIX 6 USER ACCOUNT INTEGRATION WITH OTHER SYSTEM(S) APPENDIX 7 CROSS-PLATFORM MIGRATION PROCEDURES Page 2

3 About this manual This Administrator Manual is revised from the Administrator Manual of Self-evaluation Platform (SEP). System Administrator may find the latest information about how to administer E-platform for School Development & Accountability (ESDA). For SEP specific information, please refer to its original edition. The target readers of this Administrator Manual is System Administrator, or those who are authorised to install and administer ESDA server. This Manual has the following four chapters - Chapter 1 Quick Installation of ESDA on Windows Server 2003 Chapter 2 System Upgrading for ESDA Chapter 3 Administrative Procedures Chapter 4 Suggested scheduled tasks Besides the general administrative tasks mentioned in the above chapters, there are some further guidelines provided in the Appendices on the related features of ESDA. They are- Appendix 1 Installation of ESDA on Fedora Linux 6.0 Appendix 2 Installation of ESDA on other Windows Platforms Appendix 3 ESDA File structure and software Components Appendix 4 Uninstalling ESDA Appendix 5 Installing ESDA on Windows System running IIS Appendix 6 User account integration with other system(s) Appendix 7 Cross Platform Migration Procedures How to contact us EDB welcomes schools to share with us their opinions and good practices in using ESDA. Please contact the Indicators Section of the Quality Assurance Division to express any views and suggestions, or to share experiences by phone, fax or Telephone (852) (852) Fax ( indicators@edb.gov.hk Page 3

4 Chapter 1 : Quick Installation of ESDA on Windows Server 2003 This chapter provides the installation procedures for ESDA under Windows Server Other than Windows Server 2003, the ESDA can be installed in the following operating systems: Windows 2000 Professional Windows 2000 Server Windows XP Windows Vista Fedora Linux 6.0 For detailed information, please refer to the relevant Appendices. The following are three major steps involved in the installation procedures: Pre-Installation Checklist Installation of ESDA Post-Installation Checklist Page 4

5 1.1 Pre-Installation checklist This section describes the pre-installation tasks such as identifying hardware requirements and gathering the necessary installation information that the Administrator should perform before moving onto the installation Suggested System Configurations ESDA must be installed in a computer system with the configurations as stated in Appendix 2. To ensure satisfactory performance, schools may refer to the following suggested system configurations: Item Suggested system configurations 1. Processor Intel P4 CPU 2.4 GHz or above 2. Memory 1 GB RAM or above. 3. Hard Disk 5 GB Free storage space. 4. Operating System Windows Server Internet Browser Internet Explorer 6.0 or above 6. Network Configuration Support TCP/IP network with a static IP address. 7. Internet Information Services (IIS) IIS shall not be installed; and IP port 80 is available for the use of the ESDA installation. Table 1.1: System Configurations Whether the system configuration is appropriate depends much on how schools conduct ESDA survey. For example, the above configuration works well for schools that will conduct online ESDA survey of one class of students (approximately 40 students) at the same time. If schools are planning to conduct online ESDA survey of two or more classes at same time, faster processors and greater memory are recommended. ESDA can be installed in Windows Workstations such as Windows XP or Windows Vista. However Microsoft license agreement limits the concurrent number of connections to the application system installed in Windows Workstations. Therefore, installing ESDA system in Windows Workstation is applicable for schools to administer offline ESDA survey only. In general, schools should install a new ESDA system under Windows Server 2003 or its latest version. For schools having ESDA system already installed, they can keep using the existing hardware. They can perform server upgrading if necessary. Page 5

6 ESDA also supports Linux platform. However schools should evaluate their own technical skill before deploying ESDA under Linux. For schools having ESDA installed under Redhat Linux 9.0, it is recommended to upgrade it to Fedora 6.0. Appendix 1 is the installation procedures of ESDA on Fedora Linux Installation of Necessary System Patch(es) and Browser Please install Windows Server 2003 service pack 2.0 or above. It is always recommended to install the latest service pack and update security patches. For detailed operations, please refer to Microsoft website ( The suggested browser for the ESDA is Internet Explorer (IE) 6.0 or above Checking for Other Recommended Software It is always recommended to install Anti-Virus software and update the latest virus signature on the computer in which the ESDA is installed Network Configuration Checking The ESDA package uses port 80 for Apache HTTP server. The Administrator is advised to disable the IIS service to make sure that port 80 is available for Apache HTTP server. If the server is using the IIS service for other purposes, the Administrator is advised to modify the Apache HTTP server port 80 to For detailed procedures, please refer to Appendix 5. A static IP address should be assigned to the computer in which the ESDA is installed. If the server is designed for Internet access, it must be protected by a firewall and assigned to a routable IP address Reference Site for Checking Licensing Issue on Operating System Windows Server 2003 supports two Windows Client Access Licenses (CAL): Device-based and User-based Windows CAL. Windows Device CALs might make most economic and administrative sense for an organisation with multiple users for one device. Whereas, Windows User CALs might make most sense for a school with many users who need access to the network from unknown devices and/or an organisation with employees who access the network via multiple devices. Page 6

7 For detailed information, please refer to Microsoft Product licensing website ( 1.2 Installation of ESDA Once all the necessary components for the ESDA installation have been verified, the Administrator is ready to install the ESDA Installing ESDA Step 1: Download the ESDA 1) Login to the Windows Server 2003 as an Administrator, or as a user with administration rights to the Windows Server ) Launch Internet Explorer and enter the URL 3) Download the full ESDA installation program (i.e. esda-v3.0.8.exe) and save it to your computer desktop. Step 2: ESDA installation 1) Double-click the esda-v3.0.8.exe, a warning message then appears as shown in Figure 1.1. In the warning message dialog box, click the YES button to continue. (Warning: If there is Apache or MySQL installed in the machine, please click NO button to abort ESDA installation.) 1 Figure 1.1: Warning Message 2) On the License Agreement page (Figure 1.2), click I Agree button if you accept all terms of ESDA License Agreement. Page 7

8 2 Figure 1.2: ESDA License agreement 3) The Setup program will install ESDA in a default folder, as shown in Figure 1.3. Click Install button. 3 Figure 1.3: Installation folder Note: The Administrator can change the destination folder by clicking on Browse button. Page 8

9 ESDA is starting to install, as shown in Figure 1.4. Figure 1.4: Installing ESDA 4) On the Apache installation page (Figure 1.5), click Next button. 4 Figure 1.5: Apache HTTP server installation screen Page 9

10 5) On the Apache License Agreement page (Figure 1.6), select I accept the terms in the license agreement and then click the Next > button. 5 Figure 1.6: Apache HTTP server License Agreement 6) On the Apache information screen (Figure 1.7), click the Next > button. 6 Figure 1.7: Apache HTTP server information screen Page 10

11 7) Enter the information as shown below (Figure 1.8): 8) Network Domain: The domain name, for example schoolabc.edu.hk. Server Name: The name of the server on which the ESDA is installed, for example Administrator s address: A valid address for the Administrator. Select For All Users, on Port 80, as a Service Recommended. Click the Next > button. 7 Figure 1.8: Apache HTTP Server information screen 9) On the Apache Setup Type page (Figure 1.9), select Typical and then click the Next > button. Page 11

12 8 Figure 1.9: Setup Type for Apache HTTP server installation 10) On the Apache Ready to Install the Program page (Figure 1.10), click Install button. 9 Figure 1.10: Ready to install for Apache HTTP server Page 12

13 The Apache HTTP server is being installed (Figure 1.11). Figure 1.11: Installation for Apache HTTP server 11) On the Apache Installation Wizard page (Figure 1.12), click the Finish button. 10 Figure 1.12: Installation for Apache HTTP server completed Page 13

14 12) The installation process will continue. Click the Close button after the installation process is completed (Figure 1.13). 11 Figure 1.13: Installation of other software components Step 3: System Health Check The ESDA installation program will then launch the Internet Explorer and prompt for logon, see Figure Enter the following username and password and the system will show the status of the machine and the installed components as in Figure Username: esda Password: +-*/ Figure 1.14: ESDA Logon interface Page 14

15 Figure 1.15: ESDA Installation Status report 1.3 Post Installation Checklist The following steps are the post installation checking procedures to verify that the ESDA is functional and usable Logon Test 1) Logon as an Administrator to the Windows Server 2003 where the ESDA is installed. 2) Launch Internet Explorer. 3) Type in or address or domain name>/esda. 4) The logon interface of ESDA will be displayed (Figure 1.16). Page 15

16 Figure 1.16: Logon page for ESDA Logon the System Using Default User Account The default username of an Administrator account is admin and the password is also admin. For security reason, please change the password of the default administrator user account at once System Setting Check Figure 1.17: Main Menu of ESDA after fresh installation Mouse over System Tools and click System Setting, the following system setting summary page prompts. System administrator shall run through Section 1.4 to customize the ESDA. Page 16

17 Figure 1.18: ESDA System Setting Summary 1.4 Customization To customize the ESDA, the System Administrator has to register the system with the school ESDA registration key and define the following parameters: 1) School badge 2) School year 3) System setting Upload School Badge The Administrator can update School Badge in Interface Setting (Figure 1.19). 1) Mouse over System Tools and then click on Interface Setting button. 2) Click browse button to upload a new School Badge in JPEG format. 3) The Administrator can change the system color and the default language. 4) Click Save button. Page 17

18 Figure 1.19: System Parameters Settings Update School Year System Administrator can update Current School Year if necessary (Figure 1.20). 1) Mouse over System Tools and then click on System setting. 2) Click on School Year Setting. 3) Select Current School Year. 4) Click Save button. Figure 1.20: System Parameters Settings System Registration System Administrator has to register the system with the ESDA registration key. Figure 1.21: System Parameters Page 18

19 1) Mouse over System Tools and then click on System setting. 2) Click on System Registration. 3) Enter the registration key as separated into five groups of 5 characters each. 4) Click Save button School Setting Figure 1.22: System Parameters School setting records the basic school information such as school name, SCRN, School session and school folder used in figure ) Mouse over System Tools and then click on System setting. 2) Click on School Setting. 3) Enter the required information and click Save button. Page 19

20 Figure 1.23: School Setting Other Links Setting Add other links (Figure 1.24). Figure 1.24: Set Other Links Password Management Set the password minimum length and maximum length and set the changing password authorisation to each user type (Figure 1.25). Figure 1.25: Set the Password Length Page 20

21 Chapter 2 : System Upgrading Procedures for ESDA Upgrade patches are prepared for both Windows and Linux platforms. The upgrade patches include bugs fixed and enhancement features. To download the latest upgrade patch, please visit the ESDA website (English interface) or (Chinese interface)]. If you are going to migrate ESDA from Windows platform to Linux platform or vice versa, please refer to Appendix 7 for details. 2.1 Upgrading ESDA for Windows Platform Step 1: Download the ESDA patch 1) Logon to the Windows Server 2003 as an Administrator, or as a user with administration rights to the Windows Server ) Launch Internet Explorer and enter the URL (English interface) or (Chinese interface). 3) Download the appropriate ESDA upgrade package and save it in your computer desktop. Step 2: ESDA upgrade 1) Double-click the ESDA upgrade package. 2) In the warning message dialog box, click the Yes button to continue. (Warning: If your school has not completed any questionnaire surveys in the 2007/08 school year, please click No button to abort ESDA installation.) Figure 2.1: Warning Message Page 21

22 3) On the License Agreement page (Figure 2.2), click I Agree button if you accept all the terms of ESDA License Agreement. Figure 2.2 ESDA License Agreement 4) The upgrade program will enable the system upgrade with the ESDA installation folder as shown in Figure 2.3. Click Install button. Figure 2.3: Installation folder Page 22

23 5) ESDA is being upgraded as shown in Figure 2.4. Figure 2.4 ESDA is being upgraded 6) A browser is opened and status of version upgrade is shown in Figure 2.5. Click the here link to access the login page. Figure 2.5 List of version upgrade Page 23

24 7) On the login page, the system shows a new version number, as shown in Figure 2.6. Figure 2.6 ESDA login page 2.2 Upgrading ESDA for Linux Platform Step 1: Download the ESDA patch 1) Login Linux as root. 2) Launch Internet Explorer and enter the URL (English Interface) or (Chinese Interface). 3) Download the appropriate ESDA package (i.e. ESDA_upgrade-v3.08.tar) and save it in your computer desktop. Step 2: ESDA upgrade 1) Unpack the upgrade patch file (e.g. > tar xvf ESDA_upgrade-v3.0.8.tar). 2) Copy all files and directory within the extracted folder to the ESDA installation directory (e.g. copy rf v3.0.8/* /usr/local/esda/). 3) Change directory to the db directory, if appropriate, and import the SQL statement file into MySQL database (e.g. > mysql u sep sep < v3.0.8.sql). Step 3: Check MySQL and PHP configuration 1) Search my.cnf (e.g. whereis my.cnf). 2) Check if the following lines exist, add them if not: set-variable set-variable = lower_case_table_names=1 = max_connections=1000 Page 24

25 3) Search php.ini (e.g. whereis php.ini). 4) Check if the following line exists, add it if not: error_reporting = ~E_ALL & ~E_NOTICE Page 25

26 Chapter 3 : Administrative Procedures The administrative services can be grouped into the four categories described in Table 3.1. Administrative category General administrative tasks (Section 3.1) User group and account administration (Section 3.2) Backup and recovery (Section 3.3) Problems and diagnoses (Section 3.4) Specific Tasks Stop and start ESDA, updating school year, data archive and restore archived file. Create and maintain user groups and accounts to ensure that each user can login the ESDA and access relevant resources. Perform regular backups for restoration of the ESDA data. Monitor the ESDA performance and detect problems. Table 3.1: ESDA Administrative Services The ESDA provides two types of tools that help the Administrator to perform administrative tasks. The tools are described in the following table. Tool Data Archive Health checking Administrative Tasks Archive questionnaires and log sheets. Provide an ESDA system with a status report to diagnose problems. Table 3.2: ESDA Administrative Tools This chapter will elaborate on the following administrative tasks: General administrative tasks User group and account administration Backup and recovery Problems and diagnoses Page 26

27 3.1 General Administrative Tasks To maintain the system, some administrative tasks have to be performed regularly. To stop or start the ESDA system, the Administrator can stop or start the Apache and MySQL service. After stopping the Apache and MySQL service, no one can access the ESDA. For checking the system status, the simplest way is Logon / Logout the system. The system should work properly if there is no problem in both Logon and Logout procedures. For each new school year, the Administrator should change the current school year before importing new user accounts Stop and Start ESDA This section describes how to stop and start the ESDA A) Stop the ESDA 1) Click the Start menu, mouse over Settings and click the Control Panel (Figure 3.1). Figure 3.1: Open the Control Panel Page 27

28 . 2) Click the Administrative Tools icon (Figure 3.2). Figure 3.2: Open the Administrative Tools 3) Click the Services icon (Figure 3.3). Figure 3.3: Open the Services Page 28

29 4) Click the Apache2 Service and click the Stop icon (Figure 3.4). Figure 3.4: Stop the Apache service 5) Click the MySQL Service and click the Stop button (Figure 3.5). Figure 3.5 Stop the My SQL service Page 29

30 B) Start the ESDA Repeat Steps 1 to 3 of Stop the ESDA above. 6) Click the Apache2 Service and click the Start icon (Figure 3.6). Figure 3.6 Start the Apache service 7) Click the MySQL Service and click the Start button (Figure 3.7). Figure 3.7 Start the MySQL service Page 30

31 3.1.2 Updating School Year The System Administrator should update the school year before the commencement of the next school year. After updating the school year, all class level(s) and class(es) are removed from the system. All student user accounts could not be found in any class level or class group until the Administrator updates the accounts again. Figure 3.8 Update Current School Year To update the school year, the Administrator can select the new Current School Year and click Save (Figure 3.8). School years are created automatically after the first day of the school year. For detailed procedures, please refer to the Operation Manual System Upgrade Procedures The Administrator can download the upgrade version of ESDA program and data set from the ESDA website (English Interface) or (Chinese Interface). Page 31

32 3.2 User Group and Account Administration ESDA has five types of pre-defined groups and three types of user accounts. For groups, they are System Group, Form Group, Class Group, Survey group, and Privilege Group. For user accounts, they are students and/or parents, teachers and administrators Introduction to Groups and User accounts A) Groups The following section illustrates details of the pre-defined groups and user accounts. The five types of groups are System Group, Form Group, Class Group, Survey group, and Privilege Group. All these pre-defined group types cannot be added or deleted. These five group types are used to help the Administrator to group a list of users with common properties. Each group type includes its respective Chinese and English names, as well as a list of users. Except Survey Group, they all have privileges assigned. System Group type includes pre-defined user groups which cannot be added or deleted. They are: 1) Administrator, 2) Teacher, 3) Student, 4) Parent and 5) Others. Form Group type is used to group students into forms. Schools can define Form Group according to the operating class levels. It includes a CLASSLVL code. Class Group type is used to group students into classes. Schools can define Class Group according to the operating class levels. It includes a CLASSCODE code. The relationship between classes (e.g. 1A) and forms (e.g. P1) can be built when adding or updating the classes. Form Group and Class Group can be created through the web interface or created automatically through CSV file import. Codes ( CLASSLVL and CLASSCODE ) must be assigned to Form Group and Class Group of a particular school year. Survey Group type is used to group users with common properties (e.g. students with computers at home, and students without computers at home) for group comparison in a survey analysis. The resulting privilege(s) for each account is/are the aggregated privileges of all groups that the user belongs to. There are two types of survey groups. The Global Survey Group is created by the Administrator and can be used for respondents assigned by the Survey Manager when creating a survey. The Local Survey Group is created by the Survey Manager and can be used in a particular survey only. Privilege Group type is used to assign specific access rights to a list/group of users. The Administrator can create user groups with various combination of privileges assigned. All the group types properties are summarised in the following table. Page 32

33 Group Type Group Type s Properties Group Example System Group It is inherited in ESDA system and cannot be created/ edited /deleted. When import batch students, parents and teachers accounts via csv file, user accounts will be automatically assigned into the respective system groups (i.e. students assigned to Students Group). Parent Group Student Group Administrator Group Teacher Group Other Group Form Group Class Group Survey Group Privilege Group When batch students accounts have been imported via csv file, form group will automatically be created and OR The Administrator can manually create it. When batch student accounts have been imported via csv file, class group will automatically be created OR The Administrator can manually create it. There are two types of Survey Groups: Global Survey Group and Local Survey Group Global Survey Group(s) is/are created by the Administrator in User Management Module, in which Global Survey Group can be assigned to all surveys. Local Survey Group(s) is/are created by the Survey editor, in which the Local Survey Group will be attached to a particular survey for result analysis purpose. It is created to facilitate standardised survey respondents retrieval and survey results analysis across years It is manually created by the Administrator. It is created to assign privileges to a group of users. Table 3.3: Group Type s Properties Form Name: Primary one Form Code: P1 Class Name: 1A Class Code: 1A Global Survey Group: Pilot Students, Science Subjects Group, Arts Subjects Group Privilege Group: Survey Creators, Survey Item Bank Administrators, Page 33

34 B) User Accounts In the ESDA, there are three types of user accounts. They are students and/or parents, teachers and administrators. To create student and/or parent user accounts, the Administrator can import the Student users from WebSAMS or create them in the ESDA system. To create teacher user accounts, the Administrator can import teacher user accounts from spreadsheet or create them in the ESDA. To create administrator user account, the Administrator can create it in the ESDA Group Planning Strategy Implementation of grouping strategy in ESDA will streamline administration. This section presents the guidelines for implementing survey and privilege groups. A) Implementing survey group The Administrator is advised to set up survey group for a particular survey (e.g. 1A Intranet System Usage) and add the appropriate user accounts (e.g. 1A Student User Accounts) to the survey group. This can facilitate cross group (e.g. 1A and 1B) and time (e.g. Intranet usage survey for 1A between 12-March-2005 and 12-April-2005) comparison for survey analysis. B) Implementing privilege group The Administrator is advised to create privilege group(s) based on resource access needs. For example, creating a privilege group with survey item bank management rights for the Survey Manager, creating a privilege group to manage school based attribute(s) Account Policy Planning The account policy determines how passwords should be used by user accounts. The account policy sets the requirements for: Password minimum length Password uniqueness Set the changing password authorisation to each user type To use an account policy to provide security for user accounts, the Administrator may consider the following: Page 34

35 Define a minimum length for password. The longer the password, the more difficult it is to guess. In a medium security system, the recommended password length is 6-8 characters. Unique password for all user accounts. Before a new school year starts, the Administrator needs to update student user accounts. Within a school year, the Administrator may need to update student user account (e.g. a student is transferred from 1A to 1B). If school has set up school-based Intranet system, the Administrator can replace the LOGINID and PASSWORD column in the CSV file by the login name and password of the school-based Intranet. For detailed operation procedures, please refer to the Operation Manual Add, Edit and Delete Groups and Users Accounts The Administrator can add, edit and delete Groups and User Accounts. For detailed operation procedures, please refer to the Operation Manual Import User Accounts from WebSAMS To facilitate the Administrator to create student accounts, a set of procedures is prepared for the Administrator to extract the student accounts from WebSAMS. For detailed procedures, please refer to the Operation Manual. When importing user accounts from the CSV file, the system will perform the following tasks: 1) add new user accounts, 2) update existing user accounts, 3) delete existing user accounts, and 4) create Class Groups (forms and classes). The system uses the registration number to compare user accounts between/among existing user accounts in the database and the user information in the CSV file. Detailed descriptions of the tasks are as follows: 1) There is a user in the CSV file but there is no existing user account with the same registration number in the database. The system creates a new user account with the data in the CSV file. (Add a new user account) 2) There is a user account in the database as well as a user in the CSV file with the same registration number. The system updates the user account in the database with the data in the CSV file. The class and form are also updated (class promotion) according to the user information in the CSV file. (Update an existing user account) Page 35

36 3) There is a user account in the database but no user data in the CSV file with the same registration number. Then the system removes the user account from the database. (Delete an existing user account) 4) The system creates Class Groups (forms and classes) if the Class Groups do not exist in the specific school year. The system creates Class Groups according to the CLASSCODE and CLASSLVL in the CSV files. It uses the CLASSCODE and CLASSLVL as the Chinese names, English names, and codes of the Class Groups. The system compares the current school year and the code in the Class Group and creates new Class Groups if the codes do not exist in the database. The codes in the Class Groups are used to prevent duplicated creation of Class Groups in the same school year. For example, if the school year is and there is a Class Group with a code 1A, when the Administrator imports a CSV file with 1A in CLASSCODE field in school , the system will not create a Class Group 1A Privilege Setting To set privileges for user groups, the Administrator can click the Set Privilege button next to the target user group (Fig 3.9) and then check the privileges to be assigned to the target user group and click the Save button (Figure 3.10). Figure 3.9 Set Privilege Figure 3.10 Privilege setting Page 36

37 3.2.7 Best Practices To minimise tedious jobs of ESDA group(s) and user accounts creation, the Administrator is recommended to use the batch user account creation to create student accounts, parent accounts and all school-based-group(s) (e.g. class and form groups). For detailed procedures, please refer to the Operation Manual. 3.3 Backup and Recovery The Administrator should back up the data of ESDA daily. Two directories ( c:\program Files\ESDA\datadir and c:\program Files\ESDA\mysql\data on the assumption that ESDA is installed in c:\program Files\ESDA ) should be backed up daily. The first directory (i.e. c:\program Files\ESDA\datadir ) is the program data directory. It contains the school s uploaded files (e.g. School Badge). The second directory (i.e. c:\program Files\ESDA\mysql\data ) is user data directory. All Surveys and Survey Items are stored in MySQL database System Backup Procedures School should back up the ESDA installed directory c:\program Files\ESDA to backup device (e.g. Backup Tape). To check the installed directory: Page 37

38 1) Mouse over System Tools and then click on System Backup Procedure. 2) Check the Installed Directory as shown in the figure above. 3) Follow the steps to copy the installed directory (e.g. c:\program file\esda) to a backup folder (e.g. d:\esda_backup) or backup device To recover data of ESDA To recover data of the ESDA, please make a copy of the above-mentioned installed directory and backup folder first. The simplest way is to rename the folders and remove them after the recovery task has been completed. To start the recovery task, the System Administrator should stop the ESDA (please refer to 3.1.1A), copy the backup data from backup device (e.g. Backup Tape) to the corresponding directories (e.g. c:\program Files\ESDA\datadir and c:\program Files\ESDA\mysql\data ) and then start the ESDA (please refer to 3.1.1B). If the ESDA crashes, the Administrator is advised to uninstall and then install again the ESDA. Then, it is suggested that the System Administrator restore the last backup data. To uninstall the ESDA, please refer to Appendix Problems and Diagnoses This section describes the tools and procedures for some common problems that may be encountered Resetting User Password The Administrator can select a class (e.g. Form 1A), select the student(s) and click Reset Password button. For detailed procedures, please refer to the Operation Manual Windows Event Log Monitoring The Windows Server 2003 provides a tool called Event Viewer. With Event Viewer, the Administrator can monitor events recorded in event logs. According to the event logs, the Administrator can understand the system workload and the corresponding effect on the system's resources. The event logs assist the Administrator to diagnose problems. According to the information from Microsoft ( the recommended procedures are: Page 38

39 1) Logon Windows Server 2003 as an server administrator 2) Click Start Control Panel Administrative Tools Event Viewer. 3) To open Event Viewer and to refresh the view, on the Action menu click Refresh ESDA System Log Monitoring In the ESDA, there are six types of system log to help the Administrator to review daily operations. They are Logon, Invalid Logon, User Management, Survey Item Bank, Survey Generator, Data Archive and Data Capturer (Figure 3.11). For each type of operations, the system logs contain different detailed information. Table 3.4 shows the details recorded in each type of operation. Figure 3.11 System Log To view the log records, select a date range and a log type and then click the Search button (Figure 3.12). The system shows a list of logs with a date, an operator and an operation field. To view the details of the logs, click the View button next to the log to be viewed and the system shows the details of the log with remarks (Figure 3.13). Figure 3.12 Search system logs Page 39

40 Figure 3.13 Log details For detailed procedures, please refer to the Operation Manual. Category Log Type Remark User Management Add User loginid, userid, name (en), name (zh) User Management Update User loginid, userid, name (en), name (zh) User Management Delete User loginid, userid", name (en), name (zh) User Management Restore Deleted User "loginid, userid", name (en), name (zh) User Management Import User "loginid, userid", name (en), name (zh) Group Management Add Group groupid", name (en), name (zh) Group Management Update Group groupid", name (en), name (zh) Group Management Delete Group groupid", name (en), name (zh) Group Management Set Privilege groupid, name (en), name (zh), privilege list Login User Login Record userid, loginid, accessip Survey Item Bank Management Add Folder Full path, Folder Names (Chinese and English) Survey Item Bank Management Update Folder Full path, Folder Names (Chinese and English) Survey Item Bank Management Delete Folder Full path, Folder Names (Chinese and English) Survey Management Add Survey "Survey Title, Survey ID, Full path Survey Management Copy Survey "Survey Title, Survey ID, Full path Survey Management Update Survey "Survey Title, Survey ID, Full path Survey Management Delete Survey "Survey Title, Survey ID, Full path Data Archive Management Archive data Date Range, Scope of Data, File Name Data Archive Management Restore data Data Range, Scope of Data, File Name Data Capture Input data Survey Title, Survey ID, Reference Number Table 3.4: System Logs Information Page 40

41 3.4.4 Health Checking In the ESDA, there is a tool for health checking. It is recommended that the Administrator follow the steps: 1) Logon Windows Server 2003 server as a server administrator. 2) Launch Internet Explorer. 3) Type 4) The system will prompt for login. (The default username: esda and password: +-*/) Figure 3.14 ESDA Logon interface 5) The system shows the status of the machine and the installed components. Figure 3.15 ESDA Installation Status report Page 41

42 Chapter 4 : Suggested Scheduled Tasks System Administrator should monitor the installed ESDA system regularly. The following table summarises the suggested tasks and schedules for reference: Tasks Suggested Schedules Reference 1 System Backup before upgrade Before carrying out ESDA system Administrator Manual 2 Upgrade ESDA to the latest version upgrade July August (or when new upgrade package is available) Administrator Manual 3 Start a new school year September Operation Manual 4 Import Student user list September Operation Manual 5 Update Teacher user list September Operation Manual 6 Import Stakeholder Survey package Before publishing stakeholder survey Survey Administration Guide 7 Scheduled System Backup Daily Administrator Manual Table 4.1: Scheduled administrative tasks This chapter will elaborate on the following administrative tasks: Upgrade ESDA to the latest version Start a new school year Import Stakeholder Survey Package 4.1 Upgrade ESDA to the latest version System Administrator should visit the ESDA web site ( for any new upgrade package of ESDA system. For system upgrade, the System Administrator should: Download and read the guidelines for applying update patch; Verify if the upgrade task is necessary and crucial; Schedule a suitable timing for the task; Complete a full backup on ESDA system and data; Complete all outstanding surveys published; Page 42

43 Print all survey reports and save all softcopies (if applicable); Be prepared for roll back procedure (in case the upgrade task fails); Run the upgrade and verify if it is completed successfully. 4.2 Start a new school year The ESDA system can store student records of one school year only. When the system has been set to a new school year, all student records in the previous school year are deleted. Therefore before changing the system to a new school year, it is necessary to do the following: Complete a full backup on ESDA system and data; Complete all outstanding surveys published; Print all survey reports and save all softcopies (if applicable); Be prepared for roll back procedure; Change the school year; Import student records for the new school year; Update teacher records for the new school year; Import stakeholder survey package for the new school year; Import reference data for the new school year (if necessary). Warning: Once the system has changed into a new school year with student records imported, there is no other means to restore it back to its previous stage other than the system rolls back. Contact QAD if you have problems to roll back your system at this point Roll back your system It is assumed that you have followed section 3.3 to backup the system to a backup folder, e.g. d:\esda_backup. To roll back the system to its previous version, please do the following: Check the system installed directory of your system, e.g. c:\program Files\esda; Stop the Apache server and MySQL server; copy the existing system from the installed directory to a temporary directory, e.g. copy c:\program Files\esda c:\esda_temp /s /v ; copy the backup system from backup folder d:\esda_backup back to the installed directory, e.g. copy d:\esda_backup c:\program Files\esda /s /v ; Page 43

44 Start the Apache server and MySQL server; Verify if restored system is working well; Remove the temporary directory, c:\esda_temp 4.3 Import Stakeholder Survey Package For each school year, EDB will publish a specific stakeholder survey package for that school year. School should download and import the stakeholder survey package for the current school year. Before importing the package, the System Administrator should: Change the current school year; Import student user lists; Download the stakeholder survey package from the ESDA website; Import the package to the system; note that uploading the package to the system may take some time, the System Administrator must be patient until 100% completed is shown in the status bar; Download and import the reference data if available; Publish the stakeholder surveys or APASO surveys for that year To cancel a published survey A published survey can be cancelled. To cancel a survey, click Detail button next to the survey listed in the Administration. Click Cancel button To reset the ESDA survey and KPM data The System Administrator can remove all the published stakeholder surveys, APASO surveys and KPM data to the stage that it was imported. You should obtain an activation key from EDB to complete the process. Contact QAD in case you are planning to do so. Page 44

45 Appendix 1 - Installation of ESDA on Fedora Linux 6.0 About Linux Installation 1. The purpose of this Appendix is to provide sample procedures to install ESDA on a Fedora 6 server, which is an option of Linux platform for ESDA installation. The selection of Fedora 6 is used as a reference only. As there are many different versions and editions of Linux, it should be noted that the procedures may not work with other versions and editions of Linux. 2. This installation guide is organised in a step by step approach. The objective is to simplify the installation tasks of Linux and ESDA. However, it should be noted that the System Administrator of schools must possess necessary Linux administration knowledge and is capable of handling daily operations under Linux, before he/she may select Linux as a platform for ESDA. The System Administrator must also consider the system administration issues properly, such as system security, system patching and anti-virus protection. 3. Please note that ESDA also supports many Windows server versions, from Windows NT Server to Windows Server Schools may consider administering ESDA under Windows server platform. Page 45

46 Fedora 6 Installation Guide Objectives 1. To prepare a Fedora 6 server for ESDA installation. Prerequisite: 2. Fedora 6 distributed DVD ROM (or CDROMs) 3. A networked Pentium 4 server with sufficient capability to run FC6 4. A good graphic card that supports FC6 x-windows 5. Sufficient disk storage. 6. The server should be configured as first boot from CD. Assumptions: 7. This document tested with 32 bit FC6 version only, 64-bit FC6 is out of our scope of testing. 8. It is assumed that the server does not contain any data and it is dedicated to Linux installation. Boot from CDROM 9. Switch on the computer. 10. Insert FC6 distribution DVD into the drive (or first CD disc), a boot screen appears. 11. Press [Enter] to install or upgrade in graphical mode. 12. On the CD testing screen, click [Skip] to bypass the CD media testing. 13. Press [Enter] to start x-windows. Cautions: 14. If you are not able to get a x-windows graphical display at this point, then your server graphical card may not be compatible with FC6. Abort installation if problem cannot be solved. Installation: 15. Run through ALL steps from Installing Fedora 6 to pre-esda installation. Page 46

47 Installing Fedora 6 Linux Server Detail Description 1. Select Installation Language - Highlight Englist (English) on the list - Click [Next]. 2. Keyboard Configuration - Highlight the U.S. English on the list, and click [Next]. 3. Partitioning Options - Cautions: the computer shall contain no data and it is dedicated to Linux installation. - On the pull down menu, select Remove all partitions on selected drives and create default layout - Press [Next]. - A Warning message may prompt to ask if you really want to do this, Click [YES]. Page 47

48 4. Network Configuration - Click [Edit] to modify the IP address. - Enter the IP address and check only [x] Enable IPV4 and [x] Activate on boot. - Select [manually] and assign the host name as well as Misc setting. 5. Time Zone Selection - Select location, Asia/Hong _Kong in the pull down list. - Click [Next] to proceed. 6. Set Root Password Screen - Enter the root password into the Root Password field (at least six characters long). - Type the same password into the Confirm field to ensure it is set correctly. - Click [Next] to proceed. Page 48

49 7. Task Selection Screen - Uncheck ALL. - Check only Software Development Software Development - Select Customize Later - Click [Next] to proceed. Important: Please select only Software Development and uncheck other options. 8. About to Install Screen - Click [Next] to begin the installation. 9. Installing Packages Screen - If you are installing using CDROM, Fedora Core will prompt you to change discs periodically. Click [OK] to continue. - Click [Reboot] after the installation is completed - Remove DVD from drive. Page 49

50 Configuring a Linux FC6 Server 1. Welcome Screen - Select [Forward] to start the Setup Agent. 2. License Agreement Screen - Read the License Agreement and check [x] Yes, I agree to the License Agreement - Click [Forward] to continue. 3. Firewall Setting - By default the firewall is enabled and select [Disabled]. - Select [Forward] and [Yes] to continue. N.B. User shall enable firewall later after completion of the ESDA installation. Page 50

51 4. SELinux Setting - Select [Disable]. - Select [Forward] to continue. N.B. User shall enable SELinux after completion of the ESDA installation. 5. Date and Time Setting - Verify and adjust the date and time for your system. - Select [Forward] to continue. 6. System User Screen - Create a user account esda - Select [Forward] to continue Important: Please use small letter for usernames. Page 51

52 7. Sound Card Setting - Use default setting. - Select [Finish] to continue Some Linux FC6 Operations 1. Login as root - Enter root as user name - Enter root password. 2. Exploring Media - Insert CDROM into the drive; - On menu panel icon, click Places > Computer ; - Double-click CD ROM / DVD Drive. N.B. To jump back to the previous screen, click Close button on the right upper corner. Page 52

53 3. Ejecting a CDROM - To remove a media volume. - Places > Computer - right-click on the device's icon and then select Unmount Volume or Eject. 4. Open a command prompt - On the menu panel, click Applications > Accessories > Terminal 5. Start a system services - On the menu panel, click Administration > Services - You may start / stop / restart the running services. - To start apache, seek HTTPD and click [Start]. N.B. Those checked items in the list will automatically start up on boot. RemEDBer to click [Save] before close the menu. 6. Launch Web Browser - On the menu panel, click Applications > Internet > Firefox Web Browser - Or click the Internet browser icon. Page 53

54 7. Network Configuration - On the menu panel, click Systems > Internet > Firefox Web Browser 8. Shutdown Linux - On the menu panel, click Systems > Shut Down. - Click [Shut Down] to turn the server off. N.B. System Administrator may use the Webmin to turn off the computer as well. 9. Remote Desktop - To activate sharing, click System > Preferences > Remote Desktop ; - On sharing section, check the following [x] Allow other users to view your desktop [x] Allow other users to control your desktop - On security section, Check the following [x] Require the user to enter this password - Click [Close] to continue - On a remote workstation, run VNCViewer to connect to the server. N.B. Remote desktop is active only when user logs on to his session. Warning: Remote desktop sharing can be a serious security risk. It should be turned on only when needed and not left active. Page 54

55 Pre-ESDA Installation 1. Copy software to /home/esda - Download the ESDA Linux package, unzip it and burn it to a source CD ROM. - Insert the source CD ROM into the Linux Server DVD (or CD ROM) drive. - Click Places > Computer > DVD drive. - Highlight the file(s) to be copied and right click the mouse. - Select Copy in the menu. You shall find after copying the following files in /home/esda: - MySQL Directory - esda*.tar.gz, httpd*.tar.gz, php*.tar.gz, - Explore /home/esda under Places > Computer > Filesystem. - Right click the mouse and select paste. - Reject the CD ROM after use. turck-mmcache*.tar.gz - webmin*.rpm - test.php, httpd.conf, php.ini, profile.php N.B. You may use the SSH File transfer tools to send these files to /home/esda 2. Install Webmin Locate the following file in /home/esda: webmin noarch.rpm - Double-click it and start installation. N.B. You may need Apply and Install anyway in the next popup windows. 3. Logon Webmin - Launch Firefox from Fedora Desktop; - Enter URL: - Enter root as user name; - Enter root user password; - Webmin System Information screen appears; - You may find the left menu box. - Since the resolution of Fedora may cause the Webmin difficult to use. Try step 4. Page 55

56 4. Remote Logon Webmin - Launch IE from a Windows workstation; - Enter URL: address>: where <ip address> is the ESDA server ip address; - The same Webmin logon screen appears as above. Note: You may use the Fedora Firefox brower as mentioned above handle the following steps. 5. Verify Installed packages - Click System > Software Packages on the left menu box - Software Package module index appears. - Seek Search For Package button. - Enter glibc and click the button; - It shall show glibc 2.5-3, click Return to module index ; - Enter zlib and click the button; - It shall show zlib , click return ; - Enter flex and click the button; - It shall shown flex 2.5.4a-41.fc6, click return URL. 6. Uninstall Apache (if any) - Enter Apache and click Search For Package button. - Select all, and uninstall the selected packages. - Select Yes in the following radio buttons: (x) Ignore dependencies and (x) Skip uninstall scripts; - Click Delete them all. - Reboot the server when process completed. Page 56

57 7. Install Perl-Modules - Insert FC6 DVD ROM into the Fedora DVD Drive; - Copy the file Perl-DBI-xxx-I386.rpm from the disk to /home/esda. - Launch webmin tool (see step 3 above). - Click System > Software Packages on the left menu box - Click From local file and Browse files in File to be installed: Perl-DBI fc6-I386.rpm /home/esda; - Locate and select Perl-DBI*.rpm - Click install. 8. Install MySQL Server - From Webmin, Software packages page, locate the button From local file and Browse files in /home/esda/mysql; - Select MySQL-client-standard rhel4.i386.rpm and click install. - Repeat the above steps for packages: MySQL-server-standard rhel4.i386.rpm File to be installed: MySQL-client-standard rhel4.i386.rpm MySQL-server-standard rhel4.i386.rpm MySQL-shared-standard rhel3.i386.rpm MySQL-shared-standard rh2l3.i386.rpm - In the left menu of Webmin, click Servers -> MySQL Database Server ; - Check if it is running. 9. Install Apache, PHP & MMCache - Explore file in /home/esda - locate eda_fc6_install.batch and right click the file with selection of Properities - Select Permissions and check Allow executing as program - Double click the file and click Run in Terminal on the popup message. [You may run the above command in webmin command Run batch file under command shell: /home/esda/esda_fc6_install.batch shell as alternative.] The system will run Minutes. Be patient!! Page 57

58 10. Test run the Installed Apache - Launch IE from a Windows workstation - Enter the following URL: - The PHP information page prompted. - Check the status of Turck MMCache, if it is installed. - Check status of mysql, if it is installed. - Check PHP core, verify if register_globals is on. 11. Configure MySQL Permission - On Webmin, click Servers -> MySQL Database Server - Click User Permissions - Click sep - Enter Don t change for password and Select All Permissions options; and press Save. - Click Database permissions - Click SEP - Change it to sep (small letter). 12. Configure MySQL - Click MySQL Server Configuration - Verify that the Maximum number of connections is Click Module Config - Change the command to start and stop MySQL Server as /etc/rc.d/init.d/mysql start and /etc/rc.d/init.d/mysql stop respectively. - Click Stop MySQL Server button; - Click Start MySQL Server button; - Try logging on to ESDA now. Page 58

59 13. Test run ESDA - Launch IE from a Windows workstation - Enter the following URL: - The ESDA logon screen appears. Installation Summary Software packages Version Installed path Webmin /var/webmin MySQL Client /usr/bin MySQL Database /var/lib/mysql Apache /var/local/apache PHP /usr/local/lib/php mmcache /usr/local/lib/php/extensions esda /usr/local/esda Page 59

60 Post-Installation Configuration 1. Configure Linux Firewall - Logon as root to FC6 Desktop - Choose System -> Administration -> Security Level and Firewall. - On Firewall Option, enable ports: www, ssh, secure www and port N.B. Click Other ports and Add to add TCP port Enabling SELinux - Click SELinux under Security Level Configuration. - Select Permissive in SELinux Setting. - Click OK. For detail: Disable SSH Server - Logon Webmin as root - Select on the left menu, Servers -> SSH Server - Click Stop Server Button. Page 60

61 4. Configure Webmin Apache - Select on the left menu Servers -> Apache Webserver. - Click Module Configuration Enter the following configuration; - Click Save Button when completed. - Check under Apache WebServer that the current version is Try the Start / Stop control for testing. - Apache Server root directory: /usr/local/apache - path to httpd executable: /usr/local/apache/bin/httpd - Path to the apachectl command: /usr/local/apache/bin/apachectl - Command to start apache: /usr/local/apache/bin/apachectl start - Command to stop apache: /usr/local/apache/bin/apachectl stop - Command to apply Configuration: /usr/local/apache/bin/apachectl restart 5. Configure Apache Bootup Services - Select System -> Bootup and Shutdown. - Click Create a new bootup and shutdown action. - Enter Apache as name. - Enter Apache Web server as description. - Enter the Bootup and Shutdown command as Command to start apache and Command to stop apache above. 6. Configure other Bootup Services - Click System -> Bootup and Shutdown. - Click any undesired service, e.g. bluetooth. - Check No at Start at boot time. - Click Save when completed. - Watch the boot up status changed to No N.B. The service is still running, it is disabled on next bootup. To stop it right now, check the checkbox and press Stop selected button.q 7. Reboot Server now - Click Reboot System button. Page 61

62 1-1. Batch Command Detail of esda_fc6_install.batch cd /home/esda tar -zxvf httpd tar.gz cd /home/esda/httpd /configure --with-layout=apache --prefix=/usr/local/apache --enable-module=so make make install cd /home/esda tar -zxvf php tar.gz cd /home/esda/php /configure --with-apxs2=/usr/local/apache/bin/apxs --with-mysql --with-zlib --enable-tracks-vars --with-iconv make make install cd /home/esda tar -zxvf turck-mmcache tar.gz cd /home/esda/turck-mmcache export PHP_PREFIX="/usr/local" /usr/local/bin/phpize./configure --enable-mmcache=shared --with-php-config=/usr/local/bin/php-config make make install cp modules/mmcache.so /usr/local/lib/php/extensions cd /home/esda tar -xvf esda-fc6-isntall.tar -C /usr/local cd /usr/local/esda/db mysql -u root < SEP.sql cd /home/esda cp httpd.conf /usr/local/apache/conf/httpd.conf cp php.ini /usr/local/lib/php.ini mkdir /tmp/mmcache chmod 0777 /tmp/mmcache cp test.php /usr/local/apache/htdocs Page 62

63 cp profile.php /usr/local/esda/conf 1-2. System Migration Guide 1. It is assumed that both the old and new systems are the same ESDA version. 2. To migrate the ESDA from an old system, the System Administrator has to back up the old system and restore it to a new Linux server. 3. To backup MySQL database: i. For system with webmin installed, the System Administrator may click Backup Database under MySQL Database Server option. ii. Enter /usr/local/esda/db in Backup to directory field. iii. Click Save and backup now. iv. For system without webmin installed, System Administrator may enter the following commands: # mysqldump u sep sep > /usr/local/esda/db/sep.sql 4. To backup ESDA directory: i. For system with webmin installed, System Administrator may click System -> Filesystem Backup -> Add a new backup of directory button. ii. Enter /usr/local/esda as a new backup of directory. iii. Enter the backup file name, e.g. /home/esda/esda-backup.tar. iv. Click Save and backup now button. v. For system without webmin installed, System Administrator may enter the following commands: # cd /home/esda # tar cvf esda-backup.tar /usr/local/esda 5. Assume that the new server is installed according to this installation guide. 6. Copy the backup file from the old server to the new server. SSH secure shell can be used. 7. Restore the backup file to /usr/local/esda 7.1. the System Administrator may use webmin Restore backup of filesystem type: button under Filesystem backup. 8. Restore MySQL database from /usr/local/esda/db/sep.sql 8.1. The System Administrator may try webmin Server -> MySQL Database Server -> sep -> Execute SQL button Enter /usr/local/esda/db/sep.sql in the From local file field. Page 63

64 Appendix 2 Installation of ESDA on other Windows Platforms The System Administrator can follow the same procedures as mentioned in Sections to install, verify and customise the ESDA on Windows platforms other than Windows Server License Issues on Installation of ESDA to Windows Workstation (Including Windows 2000 Professional, Windows XP) According to the information from Microsoft, schools are reminded that the maximum numbers of concurrent access to the workstation computers for Internet Information Services are as follows: Microsoft Windows Platform Maximum number of concurrent access to Internet Information Services Windows XP Professional 10 Windows XP Home 5 Windows 2000 Professional 10 Table B1 Maximum number of concurrent access to Internet Information Services For details, please refer to the End User License Agreement (EULA) which comes with the product accordingly Minimum and Recommended Hardware Requirements for Different Windows Platforms 1) Windows 2000 professional / Windows XP (Table B2) Minimum Configurations CPU: Intel PIII 450 Memory: 128M RAM Hard Disk: 5G disk space Display Card: VGA compatible Network Card: Intel interface 10 / 100M network card Keyboard and mouse Recommended Configurations CPU: Intel PIII 1G or above Memory: 512M RAM Hard Disk: 5G disk space Display Card: VGA compatible Network Card: Intel interface 10 / 100M network card Keyboard and mouse Table B2 Minimum and recommended hardware requirement for Windows workstations Page 64

65 2) Windows 2000 server / Windows Server 2003 (Table B3) Minimum Configurations CPU: Intel PIII 1G Memory: 512M RAM Hard Disk: 5G disk space Display Card: VGA compatible Network Card: Intel interface 10 / 100M network card Keyboard and mouse Recommended Configurations CPU: Intel Xeon 1.8 GHz or above Memory: 1GB RAM Hard Disk: 5G disk space Display Card: VGA compatible Network Card: Intel interface 10 / 100M network card Keyboard and mouse Table B3 Minimum and recommended hardware requirement for Windows 2000 /2003 server 2-3. Special Notes to Windows NT Workstation and Server Installation Windows NT Workstation and Server are obsolete products with no longer technical support provided from the Microsoft. It is not recommended for schools to use Windows NT for ESDA; the following information is for reference only: If installing ESDA under Windows NT, it must be installed on Chinese Windows NT Server and Workstation. The System Administrator must install Windows Installer and Windows NT Server / Workstation Service Pack 6 first. Please note the reference URL: 140F9-2D FA1-6F8A0F5DCA8F The System Administrator does not need to re-boot the computer after the Apache HTTP server is installed. Page 65

66 Appendix 3 ESDA File Structures and Software Components The ESDA includes the following components: 3-1. Windows installation Components Version Default path Apache C:\Program Files\Apache ESDA 3.0 C:\Program Files\esda * PHP C:\Program Files\esda\php MySQL 4.1 C:\Program Files\esda\mysql MySQL Data C:\Program Files\esda\mysql\data\esda Turck-mmcache C:\Program Files\esda\turck-mmcache Program Script C:\Program Files\esda\www Program Library C:\Program Files\esda\lib Data File C:\Program Files\esda\datadir * This is the default installation path of ESDA system; other paths below are relative to this Linux installation Software packages Version Installed path Webmin /var/webmin MySQL Client /usr/bin MySQL Database /var/lib/mysql Apache /usr/local/apache PHP /usr/local/lib/php mmcache /usr/local/lib/php/extensions esda /usr/local/esda Page 66

67 Appendix 4 Uninstalling ESDA The ESDA can be uninstalled with the following procedures: 1) Open Control Panel and Click Add/Remove Programs (Figure D1). 1 Figure D1 Add/Remove Programs Page 67

68 2) Click the Remove button next to Apache HTTP Server (Figure D2). 2 Figure D2 Un-install Apache HTTP Server 3) Click the Yes button to confirm (Figure D3). 3 Figure D3 Confirm un-install Apache HTTP Server Page 68

69 4) Click the Change/Remove button next to ESDA (Figure D4). 4 Figure D4 Un-install SEP 5) Click the Uninstall button to confirm (Figure D5). 5 Figure D5 Confirm SEP Un-installation Page 69

70 6) Click the Close button to complete (Figure D6). 6 Figure D6 Un-install ESDA completed 7) Select the Apache2 folder, and delete the Apache2 directory (Figure D7). 7 Figure D7 Remove Apache2 directory Page 70

71 Appendix 5 Installing ESDA on Windows System running IIS Follow the steps in to complete installation. Edit the Apache configuration file (e.g. C:\Program Files\Apache Group\Apache2\conf\httpd.conf). - Change the listening port from 80 to another port number (e.g. Listen 80 => Listen 8080). Restart the Apache2 Service (please refer to 3.1.1). Test the system with the new port. - e.g. Note: Please be reminded to update the domain name or IP in system settings. Page 71

72 Appendix 6 User Account Integration with Other System(s) 6-1 Planning for the Integration With the UAI with other system(s), you are allowed to integrate ESDA user accounts with various systems which include OpenLDAP, Active Directory, or any database systems. Basically, TCP/IP is used to make connection between systems. To achieve the integration, you should ensure that the connection between ESDA and the master system(s) is ready. In addition, you should prepare a user account mapping between ESDA and the master system. You may need some special functions which are not enabled by default in PHP in order to connect the master system(s). For details, please visit If you follow the integration example provided in this document, you should enable the LDAP function in PHP. (You need to recompile PHP if ESDA has been installed in Linux). To enable the UAI, you need to prepare a PHP script called SEPAuthorization.php located in [SEP]/userscript/ and add a variable $EnableOtherAuthorization to [SEP]/conf/profile.php with value true. After completing the setting, you can start to map ESDA user accounts with those of the master system. To perform a simple UAI testing, you can search a user account (e.g. admin) and enter value in field REMOTEID (a user account with the value entered in Remote ID must exist in the master system). Login ESDA with login ID (e.g. admin) in ESDA and password in the master system. You should review the settings and user account information if you cannot login SEP. For the detailed integration procedures, please refer to Section 3.5 in the Operation Manual. Schools are expected to create and modify [SEP]/userscript/SEPAuthorization.php file only. If you add or modify other files, you should back up your scripts together with the SEPAuthorization.php file. Otherwise, ESDA patch(es) provided by EDB may overwrite the scripts. You can retrieve more information from the following websites - For PHP: For OpenLDAP: For Active Directory: Page 72

73 6-2 Configuring ESDA for the Integration Schools can configure the authentication method in ESDA configuration file. The two modes of user login authentication are Using ESDA database and Integrating with other system(s). If Integrating with other system(s) is selected, Change Password and Student Password Reset will be disabled. Password checking will also be ignored when importing user accounts. To enable UAI in SEP, you should follow these steps:- 1. Include required PHP Module(s) and update the PHP Configuration File - In Windows Platform, you should copy related DLL to system directory (e.g. C:\WINNT\SYSTEM32) and uncomment the related library in php.ini file (e.g. C:\WINNT\php.ini). - In Linux Platform, you need to install related package(s) and then recompile PHP with appropriate option(s). 2. Update the ESDA Configuration File - Create an authorisation script (SEPAuthorization.php) and put it under [SEP]/userscript/. - Add a variable $EnableOtherAuthorization with value true in [SEP]/config/profile.php. 6-3 The Open Source Routine Schools can configure the authentication method in ESDA configuration file. The two modes of user login authentication are Using ESDA database and Integrating with other system(s). If Integrating with other system(s) is selected, Change Password and Student Password Reset will be disabled. Password checking will also be ignored when importing user accounts. An OpenLDAP (Linux) sample routine is provided for this function. Page 73

74 Figure F1 Logical Flow of ESDA authorization The following script will be called if UAI is enabled and Remote ID is not empty <?php class SEPAuthorization { function authorize($loginid, $password){ // Write your code here to validate the user account with the master system // Return true if the authentication is ok; otherwise, return false. } // end function } // end class?> 6-4 Understanding Remote ID Login Page Login Page Login ID and Password Invalid Login ID and Password Invalid SEP Database User Account Infomation Authenticate user Remote ID and Password Response Authenticate user Valid Other System Valid SEP Main Page SEP Main Page Authentication of existing SEP Authentication with user account integration Figure F2 Comparison between existing authentication and authentication with User Account Integration. Page 74