Points to Note for Upgrading of WebSAMS

Transcription

1 Points to Note for Upgrading of WebSAMS (Sybase and Crystal Reports) Version 1.0 Copyright Education Bureau. The Government of the HKSAR. Page i

2 Table of Contents 1 TARGET AUDIENCE SYBASE SQL ANYWHERE INTRODUCTION Use of reserved keyword CONFLICT Outer references in the ON phrase Explicit ORDER BY clause Access system views CRYSTAL REPORTS INTRODUCTION RE-CONFIGURATION OF WORKSTATION CRYSTAL REPORT DESIGNER UPDATE CUSTOMIZED CRYSTAL REPORTS TEMPLATES Update the database connection of the report templates Verify the SQL syntax of your report templates Issue about the.r..950 string found in the reports generated in MS Word and RTF format Save and upload each updated customized crystal reports template...16 Copyright Education Bureau. The Government of the HKSAR. Page ii

3 Amendment History Change Number Revision Description Author Revision Number Date Copyright Education Bureau. The Government of the HKSAR. Page 1

4 1 Target Audience This document is mainly for the attention of school users in particular to those who like to build and maintain: Queries in Data Management module of WebSAMS; Packages in Data Query Tool (DQT) module of WebSAMS; Customized report templates of Crystal Reports. Copyright Education Bureau. The Government of the HKSAR. Page 2

5 2 Sybase SQL Anywhere Introduction Upgrading of WebSAMS will involve the replacement of database management system from original Sybase ASA 7 database to Sybase SQL Anywhere 10. It is observed that under the new environment of Sybase 10, some issues can be found such as: (a) If unsupported syntax of Sybase 7 is embedded in the SQL statement of a query written for the Data Management module, error message will be displayed when the query is saved or executed. (In the function of [S-DAT04-03] Data Management > Execution) (b) If unsupported syntax Sybase 7 is embedded in the SQL statement of a task in a package written for the Data Query Tool (DQT) module, error message will be displayed when the task is saved and executed. (In the function of [S-DQT01-08] Data Query Tool>Package maintenance>package Information>Task Information) (c) For the case of running the user-customized templates of Crystal Reports in WebSAMS with unsupported SQL syntax of Sybase 7 embedded, system error page will show up. (d) The default sorting order of some query results may be different from that generated by Sybase 7. In order to ensure the user-customized data queries in Data Management module and Crystal Reports templates can be adapted to the new environment, users are necessary to update those user-customized SQL statements by referring to hints as follows: Use of reserved keyword CONFLICT Starting from Sybase 10, the word CONFLICT has been reserved as a keyword. Any existing table or table column named conflict appearing in SQL statement has to be enclosed in the double quotation marks. Example Original Syntax in WebSAMS 1.0 Select * from conflict Suggested syntax in WebSAMS 2.0 Select * from conflict Copyright Education Bureau. The Government of the HKSAR. Page 3

6 2.1.2 Outer references in the ON phrase Under the Sybase 10, if commas is used between table expressions, an ON condition of a join can reference a table that is not part of that JOIN but precedes it syntactically in the FROM clause. For such cases, the whole SQL statement has to be rewritten in ANSI SQL-92 syntax with INNER JOIN and OUTER JOIN keywords explicitly presented. Example Original Syntax in WebSAMS 1.0 Select a.* from tb_sch_school a, tb_sch_levelsession b left outer join tb_sch_schclass c on a.suid = c.suid and a.schyear = c.schyear where a.suid=b.suid and a.schyear=b.schyear and a.suid=9999 Suggested syntax in WebSAMS 2.0 Select a.* from tb_sch_school a inner join tb_sch_levelsession b on a.suid = b.suid and a.schyear = b.schyear left outer join tb_sch_schclass c on a.suid = c.suid and a.schyear = c.schyear where a.suid=9999 Copyright Education Bureau. The Government of the HKSAR. Page 4

7 2.1.3 Explicit ORDER BY clause In the absence of an ORDER BY clause, Sybase returns rows in whatever order that is most efficient. That means the appearance of result sets generated by Sybase 10 may be different from those by Sybase 7 depending on when you last accessed the row and other factors. For all SQL statements with the purpose of listing the results in a particular order, an explicit ORDER BY clause has to be added. Example Original Syntax in WebSAMS 1.0 Select * from tb_sch_school Suggested Syntax in WebSAMS 2.0 (if applicable) Select * from tb_sch_school order by suid, schyear Access system views For all SQL Statements containing the system view such as SYSCOLUMNS, the view has to be specified with its owner name SYS Example Original Syntax in WebSAMS 1.0 Select * from SYSCOLUMNS Suggested Syntax in WebSAMS 2.0 Select * from SYS.SYSCOLUMNS 3 Crystal Reports 3.1 Introduction To cater the changes after upgrading the WebSAMS to version 2.0, you are required to follow the steps below to re-configure the workstations and update your user-customized reports in order to let them run smoothly in the new environment. Copyright Education Bureau. The Government of the HKSAR. Page 5

8 3.2 Re-configuration of workstation crystal report designer As a pre-requisite, please make sure the workstation for designing report templates, inside the WebSAMS network segment that has Crystal Reports 9 installed, has been re-configured to: (a) remove the Sybase 7 ODBC driver and install Sybase 10 ODBC driver; (b) install service pack 7 for Crystal Reports 9.0 (c) configure two ODBC accounts. as specified in Installation Guidelines for WebSAMS 2.0, Section 9, Crystal Reports Installation in workstation 3.3 Update customized Crystal Reports templates Three types of changes/processing can be applied to each customized report templates: (a) update the database connection (mandatory); (b) verify the SQL syntax (when necessary); (c) avoid the issue about the.r..950 string (when necessary). Once appropriate modification had been applied to a user-customized report template, it has to be uploaded back to WebSAMS for production Update the database connection of the report templates For each user-customized report template, please follow the steps below to update the database connection: 1. Open your user-customized report template and execute verify database. Path: Database Verify Database Copyright Education Bureau. The Government of the HKSAR. Page 6

9 2. At the login page, remove the value in the User ID field and leave it blank. Click OK to proceed. Remove the value and leave it blank 3. Another window will be displayed. Remove the value in the User ID field and leave it blank. Click Finish to proceed. Remove the value and leave it blank Copyright Education Bureau. The Government of the HKSAR. Page 7

10 4. The system will start verifying the database and alert messages will be prompted several times. Click OK every time until all alert boxes are closed Verify the SQL syntax of your report templates If your user-customized report templates contain SQL statements, you need to perform the following steps: 1. Check syntax of all SQL statements embedded 2. Rectify incorrect SQL statements according to the hints mentioned in section 1 of this document Issue about the.r..950 string found in the reports generated in MS Word and RTF format A known issue has been recognized that reports generated by Crystal Report Application Server 9 in MS Word and RTF format, under the environment of MS Windows Server 2003 R2 with HKSAR locale, will have a strange character string appeared at the beginning of the report. The first field with Chinese font characters in the report will be printed with a prefix of.r To avoid this issue, before updating each customized report template, you has to prepare a dummy sub-report in advance by the following steps: 1. Open the Crystal Reports application. 2. Create a New Crystal Report Document and choose As a Blank Report. Copyright Education Bureau. The Government of the HKSAR. Page 8

11 3. When the Database Expert window pops up, click Cancel. 4. Hide Report Header and Report Footer, and suppress Page Header and Page Footer section as well. 5. Add a text box to Details section and resize it as small as possible 6. Save the sub-report as dummy.rpt Copyright Education Bureau. The Government of the HKSAR. Page 9

12 Then, for any user-customized reports that are being generated or may be in future to be generated in MS Word or RTF output format, you should apply the following workaround to your user-customized report termplates. Update report template: 1. Open your user-customized report template. 2. Locate the first unsuppress/unhide section, such as Page Header a in the example below. Copyright Education Bureau. The Government of the HKSAR. Page 10

13 3. Right click the first unsuppress/unhide section, and select Insert Section Below. 4. A new section should be added automatically. Copyright Education Bureau. The Government of the HKSAR. Page 11

14 5. Swap the first unsuppress/unhide section with the new section by drag and drop, such that the new section is on top of the first unsuppress/unhide section. 6. Insert the dummy subreport created in steps 1-6 to the new section. Path: Insert subreport Copyright Education Bureau. The Government of the HKSAR. Page 12

15 7. Right click the subreport and choose Format subreport. Copyright Education Bureau. The Government of the HKSAR. Page 13

16 8. In Common tab, uncheck Can Grow. 9. In Border tab, change all line style to None Copyright Education Bureau. The Government of the HKSAR. Page 14

17 10. Resize the subreport to minimum 11. Right-click the section contains the dummy sub-report and select Merge Section Below Copyright Education Bureau. The Government of the HKSAR. Page 15

18 12. Section is merged Save and upload each updated customized crystal reports template 1. Save each of your report template after the modifications have been made. 2. Upload each report template to WebSAMS Server. Path: [S-RPT02-02] Report Management > Template > Upload Template 3. Print and check each updated report in WebSAMS. -END- Copyright Education Bureau. The Government of the HKSAR. Page 16