Crxi Net Deployment

Crystal Reports XI and Visual Studio.NET Application Deployment Overview This document discusses the options for deploying Visual Studio .NET applications built using the stand-alone version of Crystal Reports XI for use in both Visual Studio 2002 and Visual Studio 2003. Both merge modules and server install packages are discussed. Contents INTRODUCTION ............................................................................................ 2 INCLUDING REPORTS IN .NET APPLICATIONS ................................................ 2 OVERVIEW OF DEPLOYMENT METHODS ......................................................... 3 DEPLOYING USING THE MERGE MODULES ..................................................... 3 Report files (.rpt)..........................................................................................3 Crystal Reports merge modules ...................................................................3 Crystal11_NET_EmbeddedReporting.msm ................................................ 4 CrystalReports11_Maps.msm ....................................................................... 4 DEPLOYING USING THE SERVER INSTALL ...................................................... 4 OBTAINING AND ADDING THE KEYCODE ........................................................ 4 DEPLOYING AN ASP.NET WEB APPLICATION ............................................... 4 DEPLOYING A WINDOWS APPLICATION ......................................................... 6 CUSTOMIZING YOUR INSTALL....................................................................... 7 Choosing which database drivers to install................................................. 7 Choosing which export drivers to install..................................................... 8 Choosing whether to install the Crystal viewers ........................................ 9 .NET FRAMEWORK .................................................................................... 10 FINDING MORE INFORMATION .................................................................... 11 Knowledge Base Articles............................................................................11 Additional Resources .................................................................................11 3/29/2006 1:33:00 PM Copyright © 2003 BusinessObjects. All Rights Reserved. Page 1 NET) to create a new Crystal Report or modify an existing Crystal report. Having reports as an embedded resource allows . This means that the report will be compiled into the assembly’s manifest. All Rights Reserved. In the Properties window change the Build Action property from Embedded Resource to None.NET Solution Explorer window. You can use the Crystal Reports Designer in Visual Studio . reports will have to be loaded from disk. and will not be loaded from a separate report file (. respectively. You can keep the report on a local computer or publish it as a Report Web Service on a web server.NET platform. 2. therefore. After adding a report to a project. The advantage of this is that applications do not have to deploy external report files and end users cannot modify them. Depending on whether you develop a Windows or web application. The advantage of keeping reports outside of the assembly is that reports can be easily modified and redeployed without having to recompile and redeploy the entire assembly. 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA. When deploying applications that do not embed report files.NET Application Deployment Introduction Crystal Reports XI extends the powerful reporting capability of Crystal Reports on the Microsoft .NET (VS . you can host the report with either the Windows Forms Viewer or the Web Forms Viewer.doc Page 2 . they are added by default as an embedded resource for the application. The disadvantage is that if a report needs to be modified. To prevent reports from being compiled into the assembly’s manifest as an embedded resource. Including reports in .NET Windows or web application. highlight the report in the . the report files must be manually added to the setup projects.NET applications When reports are added to a . Reports can be loaded from disk by specifying a file path using the Load method of the ReportDocument object. use the following steps: 1. Using the above steps will not compile the report into the assembly’s manifest. the entire application must be recompiled and redeployed for the report changes to be saved.rpt). crxi_net_deployment.Crystal Reports XI and Visual Studio . The disadvantage is that strongly-typed report objects cannot be used in the application and the reports must be loaded from the hard-drive.NET applications to be distributed and deployed without having to distribute report files separately. msm (optional) Copyright © 2005 Business Objects SA. The sever install is provided for those developers who simply want to deploy the files to a server machine as a stand-alone task. however the method of deployment is different.NET Application Deployment Overview of deployment methods There are two methods for deploying the Crystal Reports XI runtime files to a deployment computer: • Using merge modules • Using the server install (also known as ‘redistributable’ or ‘interactive install’) Both scenarios install the same files.rpt) Report files (.Crystal Reports XI and Visual Studio . Crystal Reports merge modules The merge modules that need to be added to the setup project are installed with Crystal Reports XI into the C:\Program Files\Common Files\Merge Modules directory. only one merge module needs to be included and a second is optional: 3/29/2006 1:33:00 PM • Crystal11_NET_EmbeddedReporting. Refer to the previous section.rpt) need to be distributed when a . For Crystal Reports XI. Deploying using the merge modules The components to add to Setup Projects for distributing and deploying Crystal Reports 10 applications include: • Report Files (. All Rights Reserved. Merge modules are provided for those developers who want to include the Crystal Reports runtime files along with the install package for the surrounding application.doc Page 3 .NET application is deployed. crxi_net_deployment. How the report files are deployed depends on the need and architecture of the application.msm • CrystalReports11_maps.NET Applications for details on deploying report files.zip on the Business Objects support site. Including Reports in . Updated versions of the merge modules can be found by searching for crxi_net_merge_modules. Previous versions of Crystal Reports required three or more merge modules be included in a setup project to deploy reports.rpt) • Crystal Reports Merge Modules Report files (. CrystalReports11_Maps. This WindowsInstaller package is in the C:\Program Files\Common Files\Merge Modules – the file name is CrystalReports11_NET_EmbeddedInstall.) Obtaining and adding the keycode When Crystal11_NET_EmbeddedReporting. RAS SDK Assemblies. All Rights Reserved. it exposes a Keycode property that accepts a keycode.doc Page 4 . database components and export components.msm This merge module is used to install the files required to display geographic maps inside reports. This keycode is emailed when the product is registered. refer to More Information.msi. This keycode can also be found in Visual Studio . or deploying multiple Windows applications to the same computer.msi) file on the computer you are deploying to and enter your Crystal Reports XI keycode when prompted. Deploying using the server install The server install works only with the full version of Crystal Reports XI Developer or Server editions. Deploying an ASP.msm This merge module contains CrystalReportViewer controls. Run the install (. To deploy 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA.NET applications. The keycode is listed in the Installed Products listbox. it is recommended that the Crystal dependencies be installed separately.zip on the Business Objects support site.NET web application The following procedures assume that you already have a web application or web services application ready for deployment. When deploying a web application. The 23-digit keycode must be entered into the LicenseKey property for the Crystal11_NET_EmbeddedReporting. report processing engine. This merge module is only required if geographic mapping is included in your reports.msm merge module. (see Keycodes for more information.NET SDK assemblies. Updated versions of the install package can be found by searching for crXI_net_server_install.Crystal Reports XI and Visual Studio .msm is added to a setup project. crxi_net_deployment. Crystal Reports . This merge module is always required for Crystal Reports XI .NET on the Help menu by clicking About Microsoft Development Environment.NET Application Deployment Crystal11_NET_EmbeddedReporting. NOTE For information on keycode errors. 11. 4. open your web application and on the View menu click Solution Explorer. in the Solution Explorer. You can now customize your install by excluding unneeded database and export files. right-click your web application solution. and then click Project Output. In VS . Click Setup and Deployment Projects in the left pane.msm merge module to display the properties. click Open to add it to your project. If you deploy a web application that uses an ADO . and then click OK. and then click Merge Module. 3. In the Solution Explorer. In the Solution Explorer. Refer to the Keycode section for more information. then include the two additional merge modules listed in the Runtime section above. The Add New Project dialog box appears. click both Primary Output and Content Files. click Add.msm and dotnetcrystalreports.NET Web application using the Crystal Reports XI merge modules. complete these steps: NOTE 1. 10.NET Dataset. Click the Crystal11_NET_EmbeddedReporting. right-click the Web Setup Project. All Rights Reserved. In the Solution Explorer. right-click the file then click Exclude. 5. To exclude these files. some detected dependencies will be added. Refer to the Customizing Your Install section. Expand MergeModuleProperties and type a valid keycode in the Keycode properties box. ƒ The dotnetfxredist_x86_enu. 12. and then Click OK. 8.doc Page 5 . 2. right-click your deployment package (WebSetup1) in the Solution Explorer and then click Build.NET Application Deployment an ASP . ƒ This is mandatory whenever you deploy a Crystal Reports for Visual Studio .Crystal Reports XI and Visual Studio . From your WebSetup project. The Add Modules dialog box appears. click Add. Click OK. 9. 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA. 7. click the Crystal11_NET_EmbeddedReporting. and then click New Project. crxi_net_deployment. The Add Project Output Group dialog box appears. ƒ When the Primary Output is added to the project. click Add.NET. click Web Setup Project in the right pane. While pressing the CTRL key. right-click the WebSetup project. 6.NET application. To build your Web Setup project.msm dependencies should be excluded if they are not already.msm merge module. click Add. If you deploy a Windows application that uses an ADO.NET Dataset. click the Crystal11_NET_EmbeddedReporting. 4. 7. and then click New Project. To deploy a Windows application using the merge modules. In the Solution Explorer. click Add.NET Web application. some detected dependencies will be added. To exclude these files. 2. Click OK. Refer to the Keycode section. The Add Modules dialog box appears. Deploying a Windows application The following procedures assume that you already have a Windows application ready for deployment. ƒ The dotnetfxredist_x86_enu. and then click Merge Module. While pressing the CTRL key. In the Solution Explorer.NET Application Deployment You are now ready to deploy your ASP. crxi_net_deployment. In the Solution Explorer. Expand MergeModuleProperties and enter a valid keycode in the Keycode properties box. open your web application and on the View menu click Solution Explorer. The Add Project Output Group dialog box appears. and then click OK. right-click the Setup Project. ƒ When the Primary Output is added to the project. 6. complete these steps: NOTE 1. Click the Crystal11_NET_EmbeddedReporting. 9. click Setup Project in the right pane. and then click Project Output. 5. right-click the file then click Exclude.msm and dotnetcrystalreports. in the Solution Explorer. 10. and then click OK. From your Setup Project. click both Primary Output and Content Files.msm merge module. Click Setup and Deployment Projects in the left pane.NET. 3.msm dependencies should be excluded if they are not already. click Open to add it to your project.msm merge module to display the properties. right-click your windows application solution. 8. right-click Setup Project.doc Page 6 . All Rights Reserved. The Add New Project dialog box appears. include the two additional merge modules listed in the Runtime section above. 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA. click Add. In VS .Crystal Reports XI and Visual Studio . InstallCRDB_ODBC Crystal Reports database driver for ODBC. Set the value of a specific driver to 0. InstallCRDB_ADOPLUS Crystal Reports database driver for Microsoft ADO.NET. and the crystalreportviewers11 IIS virtual directory. All Rights Reserved. to exclude the driver from your deployment project.msm merge module allows you to specify installation options for database drivers.msm. InstallCRDB_ADO Crystal Reports database driver for Microsoft ActiveX Data Objects/OLE DB. crxi_net_deployment. InstallCRDB_CDO Crystal Reports database driver for Crystal Data Object.NET. click Crystal11_NET_EmbeddedReporting. InstallCRDB_DATASET Crystal Reports database driver for DataSet provider. 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA. Set the value of a specific driver to 1. export drivers. highlight and right-click your deployment package (setup1) in the Solution Explorer.Crystal Reports XI and Visual Studio . InstallCRDB_COM Crystal Reports database driver for COM data provider. Choosing which database drivers to install 1. By default. 2. 11. InstallBTRIEVE rystal Reports database driver for ervasive database. Property name for database escription driver InstallACT rystal Reports database driver for CT databases. To build your Setup Project.NET Application Deployment ƒ This is mandatory whenever you deploy a Crystal Reports for Visual Studio . You are now ready to deploy your Windows application. all of these install with Crystal11_NET_EmbeddedReporting. and click Build. Customizing Your Install In Crystal Reports XI and Visual Studio . to include the driver with your deployment project. 3.NET application. InstallCDO32 rystal Data Object database driver.msm and in the Property window. the Crystal11_NET_EmbeddedReporting. expand MergeModuleProperties.doc Page 7 . In your deployment project. Crystal Reports database driver for xBase. Crystal Reports database driver for Query Data. Crystal Reports database driver for DB2 Server. Crystal Reports database driver for Exchange Server Admin. Crystal Reports database driver for Public Folder ACL. Choosing which export drivers to install 1.NET Application Deployment InstallCRDB_ORACLE InstallCRDB_QUERY InstallDAO InstallFIELDDEF InstallFILESYSTEM InstallIBM_DB2 InstallINFORMIX InstallP2BBDE InstallP2BXBSE InstallP2IXBSE_DLL InstallP2SACL InstallP2SEVT InstallP2SEXSR InstallP2SMAPI InstallP2SMSIIS InstallP2SOUTLK InstallP2SREPL InstallP2STRACK InstallP2SWBLG InstallSYBASE Crystal Reports database driver for Oracle. Crystal Reports database driver for Informix Online Server.doc Page 8 . Crystal Reports database driver for Outlook Data. Crystal Reports database driver for Sybase. Copyright © 2005 Business Objects SA. expand MergeModuleProperties. Crystal Reports database driver for Microsoft Data Access Objects. Crystal Reports database driver for File System data. 3/29/2006 1:33:00 PM In your deployment project. Crystal Reports physical database DLL for xBase. Crystal Reports database driver for IIS Log Files. All Rights Reserved. crxi_net_deployment. Crystal Reports database driver for Exchange Server Message Tracking Logs. Crystal Reports database driver for Field Definitions.Crystal Reports XI and Visual Studio . Crystal Reports database driver for Exchange Folders and Address Book. Crystal Reports database driver for IDAPI. Crystal Reports database driver for Web Log Files. Crystal Reports database driver for Exchange Public Folder Replica. click Crystal11_NET_EmbeddedReporting.msm and in the Property window. Crystal Reports database driver for NT Event log. All Rights Reserved. Crystal Reports export driver for Separated Export Values Format. Crystal Reports export driver for Lotus Notes Mail Export Format. Property name for export driver InstallU2DMAPI InstallU2DNOTES InstallU2DVIM InstallU2FCR InstallU2FHTML InstallU2ODBC InstallU2FPDF InstallU2FREC InstallU2FRTF InstallU2SEPV InstallU2FTEXT InstallU2FXLS InstallU2FXML Description Crystal Reports export driver for MAPI Export Format. Crystal Reports export driver for Report Export Format. Set the value of a specific driver to 0. to exclude the driver from your deployment project. 3. Crystal Reports export driver for HTML 4.msm and in the Property window. Crystal Reports export driver for Text Export Format. Crystal Reports export driver for Records Export Format.NET Application Deployment 2. Crystal Reports export driver for PDF Export Format. crxi_net_deployment. Crystal Reports export driver for Excel Export Format. In your deployment project. to include installation of the crystalreportviewers11 IIS virtual directory with your deployment project. 3. to include the driver with your deployment project.0 Export Format.doc Page 9 . Crystal Reports export driver for Rich Text (rtf) Export Format. Set the value of the property to 1.Crystal Reports XI and Visual Studio . Crystal Reports export driver for ODBC Export Format. to exclude installation of the crystalreportviewers11 IIS virtual directory with your deployment project. Crystal Reports export driver for Lotus Notes Database Destination Export Format. 2. Set the value of the property to 0. Property name for virtual 3/29/2006 1:33:00 PM Description Copyright © 2005 Business Objects SA. click Crystal11_NET_EmbeddedReporting. Crystal Reports export driver for XML Export Format. Choosing whether to install the Crystal viewers 1. Set the value of a specific driver to 1. expand MergeModuleProperties. When a setup project is created.NET rely on the NET Framework.doc Page 10 .NET framework Since projects created in VS. There are several ways to distribute the framework. the framework must also be distributed and/or installed on the target computer. For more information refer to the following link: http://msdn.Crystal Reports XI and Visual Studio . All Rights Reserved. crxi_net_deployment. .com/netframework/downloads/framework1_1/ 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA.microsoft.NET Application Deployment directory installation InstallViewerVirtualDir Property to control whether the crystalreportviewers11 IIS virtual directory is installed. usually the framework is not automatically included. com/products/dev_zone/default.asp www.businessobjects.Err Msg: ". Crystal Enterprise. All Rights Reserved. and 6. Specifications subject to change without notice. or by any information storage and retrieval system. and WebIntelligence are trademarks or registered trademarks of Business Objects SA in the United States and/or other countries. Crystal Analysis. The information in this document is subject to change without notice. BusinessQuery. duplication.352.555. Crystal Analysis Holos. Rapid Mart. crxi_net_deployment. The Business Objects logo.businessobjects. 3/29/2006 1:33:00 PM Copyright © 2005 Business Objects SA.com/fix/samplescr." c2011205 . 6.027. job failed because a free license could not be obtained..NET information and resources. recording.Err Msg: "Invalid or missing Keycodev2. Crystal Info.com No part of the computer software or this document may be reproduced or transmitted in any form or by any means.490. BusinessObjects Broadcast Agent.com/products/reporting/crystalreports/n et/default. Various product and service names referenced herein may be trademarks of Business Objects SA. 6. This software and documentation is commercial computer software under Federal Acquisition regulations. the Business Objects tagline. Crystal Reports. electronic or mechanical. Business Objects does not warrant that this document is error free. The use. BusinessObjects.S.NET Product site: http://www.doc Page 11 .247.asp Developer Zone: http://www. including photocopying. All rights reserved.227-7013. without permission in writing from Business Objects..businessobjects.578.. All other company. Not responsible for errors or omissions.289. or brand names mentioned herein.dll or invalid keycode" appears in VS .593. visit these sites: .businessobjects.dll" when deploying a .403. Copyright © 2005 Business Objects SA. or disclosure by the U.asp Listing of sample applications: http://support.Err Msg: "Cannot find keycodev2. search for the following knowledge base articles on our support site: c2010681 . Government is subject to restrictions set forth in subdivision (c) (1) (ii) of the Rights in Technical Data and Computer Software clause at 252.. 6. and is provided only under the Restricted Rights of the Federal Acquisition Regulations applicable to commercial computer software provided at private expense. product.008.NET application c2012716 . The Business Objects product and technology are protected by US patent numbers 5.NET Application Deployment Finding More Information Knowledge Base Articles For information on keycode errors.Crystal Reports XI and Visual Studio .NET Additional Resources For additional . may be the trademarks of their respective owners. Crystal Applications.