Crystal Report Designer Component

Transcription

1 Crystal Report Designer Component Overview Contents is created using the Report Source Router a class found in the CRVIEWERLib automation server. The AddReport method of the ReportSourceRouter object is used to add reports to the report collection. supports Seagate Info reports, Web reports, Seagate Crystal Reports and Crystal ActiveX reports. Report Collections can be created from any type of report source object. In order for Seagate Info and Web reports to be displayed in the Viewer, other components are required to be installed. For Seagate Crystal Reports version 7, all report types, except for Seagate Info reports, are supported since the Web component is installed on the machine by Seagate Crystal Reports. WHAT IS THE REPORTSOURCEROUTER...2 HOW TO DECLARE THE REPORTSOURCEROUTER...3 Early Binding... 3 Late Binding... 3 HOW TO CREATE REPORT COLLECTION PACKAGE USING THE DIFFERENT REPORT SOURCES...4 Using ActiveX Designer Reports... 4 Using Crystal Reports (.rpt)... 5 Using Web Reports... 5 KNOWN ISSUES WITH THE REPORT COLLECTION...7 How is the Report name determined for each report in the collection...7 Last report in the Collection is hidden...7 Errors in reports when previewing...7 TUTORIAL...7 CONTACTING CRYSTAL DECISIONS FOR TECHNICAL SUPPORT...9 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 1

2 What is the ReportSourceRouter The Web release Viewer control (version 1 that is included in the Report Designer Component) was able to view one report at a time. Users wishing to view another report could either view the other report in another view window or overwrite the existing view with the next report. [Figure A] below shows the viewer control which is displaying a single report. Notice that the group tree view in the left margin provides the ability for the user to drilldown on the report which brings up a subview in a separate tab window. Figure A is a method of adding reports to one single view. This means that users no longer need to open up additional views in order to preview reports, instead they can view all of the reports in one single view window. The group tree view on the left margin displays report icons representing the reports in the view control. You can use the group tree view to navigate the individual reports in the viewer control. Figure B below shows what the Smart Viewer control would look like with multiple reports. This Smart Viewer control in this example contains three reports. Notice the report icons in the group tree view which can expand or collapse for drillable areas on the report. Figure B Unlike a single report which uses page on demand technology when previewed, multiple reports require the whole report to be generated before being viewed. Because reports need to be generated in there entirety before being previewed the veiwer can become very resource intensive, especially for large reports. It is suggested that developers take this into consideration when determining which reports to add to the collection object. How to declare the ReportSourceRouter Early Binding The ReportSourceRouter is a hidden object in the CRVIEWERLib automation server. Checking the option "Show Hidden Members" in the Visual Basic Object browser will have this object appear in the Object browser and intellisense. Dim Rptpk As ReportSourceRouter Set Rptpk = New ReportSourceRouter Late Binding Declare the variable as a object and using the Visual Basic CreateObject function to return a class reference to the ReportSourceRouter class. Dim Rptpk As object Set Rptpk = CreateObject("ReportSourceRouter.ReportSourceRouter") 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 2

3 How to create report collection package using the different report sources The ReportSourceRouter class, which is part of the CRVIEWERLib library, is the Report Collection object. This class contains one member, the AddReport method, which adds reports to the collection. Once all the reports have been added to the collection, set the Smart Viewer control's ReportSource property to the Report Collection object. The Report collections can be created from any type of report source objects. The following examples show you how to create reports from an ActiveX Designer report source, a Crystal Report source opened directly from the object model and a web report. Though the samples are specific for each type of report source, the report collection can be a mixture of these different report sources. Using ActiveX Designer Reports The following example shows how to create a report collection package using 3 Crystal Report Designers and then assigns the package to the Viewers ReportSource property. Dim Report1 As CrystalReport1 Dim Report2 As CrystalReport2 Dim Report3 As CrystalReport3 Private Sub Form_Load() Dim Rptpk As ReportSourceRouter 'Report Collection object Set Rptpk = New ReportSourceRouter 'Instantiate the object 'ActiveX Designer reports are instantiated Set Report1 = New CrystalReport1 Set Report2 = New CrystalReport2 Set Report3 = New CrystalReport3 'ActiveX Designer reports are added to the collection Rptpk.AddReport Report1 Rptpk.AddReport Report2 Rptpk.AddReport Report3 'Set the Viewer to the Report Collection and view the report CRViewer1.ReportSource = Rptpk CRViewer1.ViewReport 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 3

4 Set Rptpk = Nothing Using Crystal Reports (.rpt) The following example shows how to create a report collection package using 3 Crystal Reports, which are accessed directly through the Object Model and then assign the package to the Viewers ReportSource property. Dim Application As CRAXDRT.application Dim Report As CRAXDRT.Report Private Sub Form_Load() Dim Rptpk As ReportSourceRouter 'Report Collection object Set Rptpk = New ReportSourceRouter 'Instantiate the object Set Application = New CRAXDRT.application 'ActiveX Designer reports are instantiated and 'added to the collection Set Report = application.openreport("c:\report1.rpt") Rptpk.AddReport Report Set Report = application.openreport("c:\report2.rpt") Rptpk.AddReport Report Set Report = application.openreport("c:\report3.rpt") Rptpk.AddReport Report 'Set the Viewer to the Report Collection and view the report CRViewer1.ReportSource = Rptpk CRViewer1.ViewReport Set Rptpk = Nothing Using Web Reports The following example shows how to create a report collection package using 2 web reports and then assign the package to the Viewers ReportSource property. The Web report broker takes care of communicating with the Web Server. When the Web report source components are created, the Web report broker is assigned to them. Once the report broker has been assigned, the URL is then 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 4

5 specified for the report source. Whenever a Web report source needs to retrieve report information, the URL is given to the Web report broker and the report request is made. This example uses early binding. To early bind the objects, in your project, a reference will need to be made to the Seagate Crystal Reports Web Report Broker (SWEBRS.DLL automation server). To use late binding for the webbroker reference "WebReportBroker.WebReportBroker" and for the websource reference "WebReportSource.WebReportSource". Note the use in the following code of the Title property on the Web report source components. Report collection packages are displayed in the Viewer accordingly with a report title. In the Web case, a title is assigned to the Web report component since it doesn't otherwise have access to any report title information. Dim webbroker As WebReportBroker Dim websource1 As WebReportSource Dim websource2 As WebReportSource Private Sub Form_Load() Dim Rptpk As ReportSourceRouter 'create broker for report sources Set webbroker = New WebReportBroker 'create a report source per report Set websource1 = New WebReportSource Set websource2 = New WebReportSource 'hook report broker to report sources websource1.reportsource = webbroker websource2.reportsource = webbroker websource1.url = " websource2.url = " 'Set report source titles websource1.title = "Employee Profiles" websource2.title = "World Wide Sales" Rptpk.AddReport websource1 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 5

6 Rptpk.AddReport websource2 CRViewer1.ReportSource = Rptpk CRViewer1.ViewReport Set Rptpk = Nothing Known issues with the Report Collection Tutorial How is the Report name determined for each report in the collection The report's Summary title is used for the report name. If the report does not have a report title specified then a report icon appears in the grouptree view but there is no title to identify the report. A report's title can be specified at runtime using the Report.ReportTitle property. Last report in the Collection is hidden. In the current release version of the Report Collection object, the last report added to the collection does not appear in the group tree view of the viewer in the initial preview. Though the report does not appear in the list it still can be navigated to using the page navigation buttons from the Smart Viewer toolbar. Eventually the last report icon does appear. This behavior does not occur on all machines and the issue is currently being tracked. Errors in reports when previewing If a report in the collection errors on preview the user is notified of the error by a message box. The report with the error is not loaded and a Report icon, with no title, is put in its place. All remaining reports are loaded into the viewer. 1. Open the Visual Basic 5.0 or 6.0 application, if it is not already running. 2. Create a new Standard EXE project by either selecting one from the Visual Basic start up dialog or navigating to New Project under the File menu. 3. Add the Report Designer by navigating to the Projects menu, selecting Add ActiveX Designer and Crystal Report 6.0 or 7.0. The Report Gallery window will appear. 4. To select a generic report format, click on the Standard button. The Create Report Expert window will appear with a series of tabs. This window allows you to select from either Project or Custom data sources. Typically, you would use a project based data source 5. You will be connecting to an existing Access ODBC data source so click on the Project button. The Select Data Source window will appear with ODBC 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 6

7 radio button on by default. Select "Xtreme sample data" from the list of data sources. 6. For this example, you'll connect to the ODBC data source using ADO. To see which options are available, in the Select Data Source window, click Advanced. The Advanced Options dialog will appear. Click OK to accept the default of connecting using ADO. 7. Now that you've specified the data source and connection method, you'll need to specify the tables to use. Click Next > on the Select Data Source window, the Select Recordset window will appear. You'll be selecting a database table object of customer sales information from the available list of database objects. Select the "Customer" object from the object pull down list and click on the Finish button. You'll return to the Create Report Expert window. Now that you've selected the database and the table for your report, you'll need to specify the fields you want to include in the report. 8. Click on the Fields tab and select the "Customer Name" database field in the Database Fields text box. Click and drag the field into the Report Fields text box. Do the same for the "Last Year's Sales", "City" and "Region" fields. 9. Click on the Sort tab and drag the "Region" and "City" fields into the Sort Fields text box. Select in ascending order if not already visible in the Order drop-down box. 10. Click on the Total tab. Because The "Last Years Sales" field is the only numeric field in the report, the expert automatically selected it for totaling 11. Click on the TopN tab. The Expert automatically selects sum of "Last Year's Sales" and Top 5. In the where N is : text box, change the "5" to a "10". 12. Click on the Graph tab and click on the Pie button in the Graph Gallery. Click on the Data tab. The Report Expert automatically creates a graph based on the sum of "Last Year's Sales". 13. Click on the Style tab and make the report a little prettier by selecting the Executive, Trailing Break style. Click Finish. The Report Expert will then present you with the option of adding a form with the Crystal Report Viewer control and setting this as the startup object. Click OK to accept the defaults. The Expert will finish formatting the report which will be displayed in the design window. 14. From the Visual Basic toolbar select Project References and check the Crystal Report Smart Viewer reference. This reference will allow us to early bind the ReportSourceRouter object. 15. From the Project Explorer window select Form2 and click the Code View icon. 16. Remove all existing code in the code view window and add the following: 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 7

8 Dim ActiveX_Report As New CrystalReport1 Dim External_Report As CRAXDRT.Report Dim Appl As New CRAXDRT.Application Dim Rptpk As New CRVIEWERLibctl.ReportSourceRouter Private Sub Form_Load() 'Adds a title to the report ActiveX_Report.ReportTitle = "ActiveX Report" 'reference and external rpt through object model Set External_Report = Appl.OpenReport("c:\program files\" + _ "seagate crystal reports\rt01.rpt") 'adds reports to the collection Rptpk.AddReport ActiveX_Report Rptpk.AddReport External_Report 'set the collection to the viewer CRViewer1.ReportSource = Rptpk CRViewer1.ViewReport Private Sub Form_Resize() CRViewer1.Top = 0 CRViewer1.Left = 0 CRViewer1.Height = ScaleHeight CRViewer1.Width = ScaleWidth Click on the Start button on the Visual Basic toolbar or press F5 to run your project. After a few seconds, you will see a form displaying the finished report in the Crystal Report Viewer. The report should look similar to the one shown below. Contacting Crystal Decisions for Technical Support We recommend that you refer to the product documentation and that you visit our Technical Support web site for more resources. 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 8

9 Self-serve Support: Support: Telephone Support: 6/24/2002 3:37 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 9