Working through the forums and support incidents I have observed that most of the issues could be resolved just by properly troubleshooting them (the application or the environment), using the vast documentation available on our community network.
The idea behind this article is to provide guidelines and the related documentation for Development, Deployment and troubleshooting various issues with a Crystal Reports .NET application.
I have tried to include as many articles, KBs as possible written by our experts.
First of all, based on the Visual Studio version you are using, choose the respective compatible version of Crystal Reports.
For checking the compatibility and the supported operating systems by each CR version see this.
So, let’s start from beginning…
Prepare your development machine-
- Install Visual Studio
- Install Crystal Reports version compatible with above version of Visual Studio.
See : KBA 1514084 - Compatibility of Crystal Reports with Visual Studio
After installation is done, quickly do below tests.
- Check your GAC for ‘CrystalDecisions.*’ assemblies, just to make sure that the SDK is installed.
NOTE: Crystal Reports 2011 and Crystal Reports 2013 does not have / install any .NET assemblies (does not have an SDK).
- Open Visual Studio, start a new project / app, check toolbox, move your mouse over Crystal reports Viewer, check the tooltip for Version. Compare it with the version of Crystal Reports you have just installed, they should be the same.
The same could be checked at the code behind of the CR viewer once it is dropped / added to a form.
Now you have prepared your Development machine for Crystal Reports .Net applications.
Let’s start developing the application.
The developer resources are here:
Crystal Reports 2008 : http://scn.sap.com/docs/DOC-27446
'SAP Crystal Reports developer version for Microsoft Visual Studio' which works with VS 2010, VS 2012 (SP5 onwards) and VS 2013 (SP9 onwards) : http://scn.sap.com/docs/DOC-7824
Evrything else is here : http://scn.sap.com/docs/DOC-27465
Now that we are well equipped with the SDK resources and a well prepared DEV environment, we are ready to develop our application.
To make any of the Crystal Report work through the application it is MENDETORY that the report should work fine from the Crystal Reports designer. If it does not work in the designer it WILL NOT work from the application / runtime.
Crystal Reports .Net SDK could be used mainly to View, Export, Print a Crystal report.
Crystal Reports .Net SDK applications can be found here.
InProc RAS .Net SDK can be used for Report creation and manipulation. Samples can be found below.
Issues could be broadly categorized as ‘How to’ issues, Environment configuration issues, Coding errors, or runtime exceptions etc.
Most of the ‘How to’ issues could be resolved by carefully studying the sample applications and the developer resources SDK Developer guide and the API reference guide.
Here are some very common issues / errors which occur while developing a Crystal Reports .Net application and few quick steps to overcome them.
Error “Load report failed”:
Check the path of the report provided in the application and if the report exists at that location.
Check if the application has permissions / rights to access the report.
For detailed steps see this: http://scn.sap.com/docs/DOC-21995
Error “Bobj is undefined” :
Error “The request could not be submitted for background processing”
- It is always recommended to set the Target platform of the application in Visual Studio while developing the application to either X86 or X64 instead of keeping it ANYCPU, which resolves many possible issues during deployment.
If you are intending to use ADO.NET datasets with Crystal Reports, here is what you should read.
- In most cases we recommend the use of the troubleshooting tools to further diagnose these issues.
So here is some information regarding the troubleshooting tools :
- For any other issues try below search which will return all the related articles, forum threads and knowledge base articles on SCN.
Which is also available at the top right corner of every SCN page.
Once you get the application working on the Development machine, it’s time to deploy the application.
The best information is provided in the Developer guide of the Crystal .NET SDK ‘Deployment’ section. Find the link to Developer guide above.
And the article “Crystal Reports and Visual Studio .NET- Application Deployment”
- Crystal Reports runtimes along with other Crystal components can be downloaded at Crystal Reports Download.
One other aspect to decide upon is Crystal Reports licensing.
Once the approach is decided and the application is deployed, few common issues which could possibly occur are as follows:
Error : “Retrieving the COM class factory for component with CLSID”
This is very common error message and is discussed many time through forums and KBs, see this search :
- Remember there are no 64 bit runtimes available for Every version of Crystal Reports.
And this article : Crystal Reports Support of 64-bit Operating Systems
For those versions of Crystal Reports which do not have 64 bit runtimes, see below article
Error: “The maximum report processing jobs limit configured by your system administrator has been reached.”
Database connectivity issues:
Most of the Database connectivity issues could be resolved by carefully configuring the server / or client machine for the application. Here are few things to do.
- Check if the database is accessible from this machine (a .udl file may help)
- Check if the same database client / driver / provided which is used on the development machine is installed here. (check database properties of the report ‘Set Database location’ option in the designer)
- If the user logging into the application / machine has rights to access the DB / DB server.
- And the basic thing, check the logon credentials supplied by the application.
Here is the utility which generates the Database logon code for a Crystal Report.
Crystal Reports .NET application performance issues:
Issues like, report takes longer on the server / client as compared to development machine.
Report takes longer on the first load and then works fine.
Report takes longer time to export / print could be resolved and performance could be optimized by adapting the guidelines provided in this article:
One more thing which plays a major role in the report performance is the performance of the Database.
Use SQL profiler or database tracing (or something similar for your DB) to observe if it is the DB which is causing the report to work slowly. Ultimately Crystal Reports is a Data representation tool.
Crystal report printing issues:
Error: “Communication error has occurred, printing will be stopped”.
This also a very generic issue and could be caused by many factors, see below search for the related forum threads and KB articles.
Here are some very good articles which speak about Crystal report printing from an application.
- For any other specific / adhoc issues/ error search our community forums and knowledge base articles here:
- If none of the above helps, post your query at our development forum
- If the issue is important or could not be resolved on forums, finally you may log a support incident with us from SAP Service Marketplace or purchase a single support incident.
- Also checkout this blog which outlines the scope of support. How can SAP Crystal Reports & BOE SDK developer support help you?