Report Designer Component 10

Transcription

1 10 Creating an RDC Deployment Package Using Wise Installer Overview Contents An application designed using the Report Designer Component (RDC) requires that multiple DLLs are present on the client computer for the application to install and run successfully. This document discusses the process of creating an RDC deployment package using Wise for Windows Installer to distribute an RDC application. INTRODUCTION... 2 DEPLOYING USING THE RDC MERGE MODULES...2 USING WISE FOR WINDOWS INSTALLER...3 Creating a new Wise for Windows Installer Package... 3 Adding the Merge Modules... 4 ADDING EXTRA FILES...5 Adding Files and Folders to your Installation Package... 5 CUSTOMIZING DATABASE DRIVER INSTALLATION OPTIONS (OPTIONAL)...6 COMPILING THE INSTALLER PACKAGE...8 CRYSTAL REPORTS 10 KEYCODE...8 FINDING MORE INFORMATION...9 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 1

2 Introduction This white paper discusses the steps for creating a deployment package using Wise for Windows Installer and the Merge Modules for Crystal Reports 10 RDC Deployments. NOTES If you are not using Wise for Windows Installer, but rather the Microsoft Visual Studio Installer 1.1, refer to Rdc10_deployment.pdf. If you would like to deploy a minimal installation package you may opt against using merge modules and individually select the necessary DLLs for your application. Refer to cr10_runtime_en.zip to determine which DLLs are required by your RDC application: Both of these documents can be found at Deploying Using the RDC Merge Modules Using merge modules is the recommended method when deploying Crystal Reports 10 applications. Using these merge modules ensure that all of the required Crystal Reports DLLs are added to the deployment package. There are five merge modules files for a Crystal Reports 10 RDC deployment. They include: NOTE These merge modules were not included with the release of Crystal Reports 10, but they can be found by searching for cr10_rdc_merge_modules.zip on our support site at: CrystalReports10_rdc_reportengine.msm - This merge module contains the Crystal Reports database and exporting DLLs. Files in this module include (but are not limited to) Crqe.dll, Crdb_ado.dll, Crdb_odbc.dll, Crxf_pdf.dll, Crxf_xls.dll, U2ddisk.dll and U2dapp.dll. This merge module is now configurable in Crystal Reports 10. Installation IDEs that support configurable merge modules (such as the VS.NET installer, Wise and InstallShield 8+) allow you to choose which Crystal Reports database drivers to install to your client's computer. CrystalReports10_rdc_runtime.msm - This merge module contains the core RDC engine required for all RDC applications. Files in this module include (but are not limited to) Craxdrt.dll, Crviewer.dll, Cselexpt.ocx, Sviewhlp.dll, Swebrs.dll. CrystalReports10_rdc_license.msm - This required merge module is configurable and requires a valid Crystal Reports 10 keycode. Refer to the Crystal Reports 10 keycode section for more information. CrystalReports10_rdc_designtime.msm (optional) - Include this merge module for applications using the Report Wizard component, or the Embeddable Designer Control. These components may require additional licensing. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 2

3 CrystalReports10_maps.msm (optional) - Include this merge module if the report contains any maps. NOTE CrystalReports10_rdc_license.msm is a configurable merge module. It is designed to prompt for a license key when it is added to an MSI-based installation package. Not all installers* are designed to work with configurable merge modules, however, CrystalReports10_rdc_license.msm is a required module and should always be included. Even if your installer does not prompt for a keycode when including CrystalReports10_rdc_license.msm, the installation should still install without error when it is included. * InstallShield 8, and Microsoft Visual Studio.NET installer can take advantage of configurable merge modules. Wise 4.0, Visual Studio Installer 1.1 and older versions of InstallShield are not able to take full advantage of configurable merge modules. To supply the keycode with an installer that does not support configurable merge modules you can use a tool like ORCA, or add a Command Line Install to your package. Using Wise for Windows Installer This method describes how to create an RDC deployment package using merge modules and Wise for Windows Installer. Creating a new Wise for Windows Installer Package To use the merge modules you need to open Wise for Windows Installer and create a new Windows Application installation file. To do this: 1. Go to the Start menu and select Programs. Click Wise Solutions and select Wise for Windows Installer. 2. The New Installation File dialog box appears. Select Windows Application and click OK. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 3

4 Adding the Merge Modules 1. After creating the new Windows Application installation file, select Merge Modules from Feature Details on the left sidebar menu. 2. In the right pane click the Add button. 3. The Add Merge Module Wizard dialog box appears. Click the Directories button. The Select Merge Modules Directories dialog box appears. 4. Click the Add button and browse to the folder where you extracted the merge modules. Click OK 5. Click OK to return to the Add Merge Module Wizard dialog box. 6. Select the following merge modules and click Next: CrystalReports10_rdc_license.msm CrystalReports10_rdc_reportengine.msm CrystalReports10_rdc_runtime.msm 7. Click Next again (so you don t change the destination directory for the merge modules). The Merge Module Configuration dialog box appears for CrystalReports10_rdc_license.msm. 8. Enter a valid keycode in the Text Value field and click Next. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 4

5 9. The Merge Module Configuration dialog box appears for CrystalReports10_rdc_reportengine.msm. This dialog box allows you to select specific database drivers to deploy with your application. All drivers are installed by default. For information on how to customize database driver installation, refer to the Customizing Database Driver Installation Options section in this document. 10. Add any additional files to your applications such as executables, reports, physical database and custom DLLs. Adding Extra Files For information on how to add additional files to your installation, refer to the Adding Extra Files section in this document. 11. Make any additional changes to the installation package and then compile the Installer Package (.msi) file. For information on how to build the Installer Package (.msi) file, refer to the Compiling the Installer Package section in this document. After building the Installer Package you can distribute it to your client computers. The following instructions describe the steps for adding extra files or folders to the installation package. Adding Files and Folders to your Installation Package 1. After creating the new Windows Application installation file, select Files from Feature Details on the left sidebar menu. In the right files pane, the top section displays the current computer s file system and the bottom section displays the destination computer s file system. 2. To add a folder, select a folder from the current file system and select the destination folder on the destination computer. Click Add Contents. The Add Contents dialog box appears allowing you to filter the files placed in the destination directory. Unless you wish to include/exclude certain files, click OK to continue. 3. To add a file(s), select a file from the current file system and select the destination folder on the destination computer. Click Add File. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 5

6 4. Repeat these steps until all necessary application files and folders have been transferred to the destination computer. Customizing Database Driver Installation Options (Optional) Your deployment may require you to include or exclude specific Crystal database drivers from your application install. Specific Crystal Reports database drivers can be individually included or excluded from the CrystalReports10_rdc_reportengine.msm merge module. When adding CrystalReports10_rdc_reportengine.msm to your setup project a prompt with a list of database drivers appears. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 6

7 Each of the merge module options corresponds to a driver in the table listed below. Setting the value for a specific driver to 1 will cause the driver to be installed with your application. Setting the value to 0 will exclude the driver from the target machine when your application is being installed. By default, all database drivers are set to install with CrystalReports10_rdc_reportengine.msm. Name InstallACT InstallBTRIEVE InstallCDO32 InstallCRDB_ADO InstallCRDB_ADOPLUS InstallCRDB_CDO InstallCRDB_COM InstallCRDB_DAO InstallCRDB_DATASET InstallCRDB_FIELDDEF InstallCRDB_FILESYSTEM InstallCRDB_JAVABEANS InstallCRDB_ODBC InstallCRDB_ORACLE InstallCRDDT32 InstallIBM_DB2 InstallINFORMIX InstallP2BBDE InstallP2BXBSE InstallP2IXBSE_DLL Description Crystal Reports database driver for PC Databases Crystal Reports database driver for Pervasive Databases Crystal Data Object database driver Crystal Reports database driver for Microsoft ActiveX Data Objects/OLE DB Crystal Reports database driver for Microsoft ADO.NET Crystal Reports database driver for Crystal Data Object Crystal Reports database driver for COM data provider Crystal Reports database driver for Microsoft Data Access Objects Crystal Reports database driver for DataSet provider Crystal Reports database driver for Field Definitions Crystal Reports database driver for File System data. Crystal Reports database driver for Java data Crystal Reports database driver for ODBC Crystal Reports database driver for Oracle Crystal Reports Data Definition Tool Crystal Reports database driver for DB2 Server Crystal Reports database driver for Informix Online Server Crystal Reports database driver for IDAPI Crystal Reports database driver for xbase Crystal Reports physical database DLL for xbase 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 7

8 InstallP2SACL InstallP2SEVT InstallP2SEXSR InstallP2SMAPI InstallP2SMSIIS InstallP2SOUTLK InstallP2SREPL InstallP2STRACK InstallP2SWBLG InstallQUERYBUILDER InstallSYBASE Crystal Reports database driver for Public Folder ACL Crystal Reports database driver for NT Event Log Crystal Reports database driver for Exchange Server Admin Crystal Reports database driver for Exchange Folders and Address Book Crystal Reports database driver for IIS Log Files Crystal Reports database driver for Outlook Data Crystal Reports database driver for Exchange Public Folder Replica Crystal Reports database driver for Exchange Server Message Tracking Logs Crystal Reports database driver for Web Log Files Crystal Query Builder Crystal Reports database driver for Sybase Compiling the Installer Package After you configure all elements of an application's installation in your installer project (by specifying folder and file locations, file associations, registry actions, and so on), you must build the project into an Installer Package (.msi) file. You can then distribute the.msi file to customers who want to install your application. To build an installer package (.msi) file: 1. In the bottom-right toolbar click Compile Crystal Reports 10 Keycode 2. If have not yet saved this project you will be prompted to save your.msi file Your distributable.msi file will be placed in the same folder as your project file. A Crystal Reports keycode is used to validate the licensing for the application. The CrystalReports10_rdc_license.msm merge module requires a valid keycode to be specified. The license key is the alphanumeric string you receive when registering Crystal Reports. NOTE Please note that this is not the 10-digit registration number. The keycode will have the following pattern: xxxxx-xxxxxxx-xxxxxxx. The keycode is located by using the Crystal License Manager installed on the computer with Crystal Reports 10. To access the Crystal License Manager, select the Crystal Reports 10 Tools program group in the Start menu. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 8

9 Finding More Information For more information and resources, visit the support area of the web site at: and refer to the following document: Rdc10_deployment.pdf - This document describes the process of creating an RDC deployment package to distribute an RDC application. This document is for use with Crystal Reports The Business Objects product and technology are protected by US patent numbers 5,555,403; 6,247,008; 6,578,027; 6,490,593; and 6,289,352. The Business Objects logo, the Business Objects tagline, BusinessObjects, BusinessObjects Broadcast Agent, BusinessQuery, Crystal Analysis, Crystal Analysis Holos, Crystal Applications, Crystal Enterprise, Crystal Info, Crystal Reports, Rapid Mart, and WebIntelligence are trademarks or registered trademarks of Business Objects SA in the United States and/or other countries. Various product and service names referenced herein may be trademarks of Business Objects SA. All other company, product, or brand names mentioned herein, may be the trademarks of their respective owners. Specifications subject to change without notice. Not responsible for errors or omissions. Copyright 2004 Business Objects SA. All rights reserved. 5/12/2004 4:02 PM Copyright 2004 Business Objects. All rights reserved. Page 9