OData Connector for SAP Crystal ReportsOData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started. In this article you will learn how to quickly and efficiently integrate OData data in SAP Crystal Reports without coding. We will use high-performance OData Connector to easily connect to OData and then access the data inside SAP Crystal Reports. Let's follow the steps below to see how we can accomplish that! OData Connector for SAP Crystal Reports is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to OData in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from OData using SAP Crystal Reports we first need to create a DSN (Data Source) which will access data from OData. We will later be able to read data using SAP Crystal Reports. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
OdataDSNOData -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataNo Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcOptional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion Fill in all required parameters and set optional parameters if needed:
OdataDSNODataWindows Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcThis Authentication Type has no parameters to fill-in. Fill in all required parameters and set optional parameters if needed:
OdataDSNODataBasic Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion Fill in all required parameters and set optional parameters if needed:
OdataDSNODataNTLM Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName (i.e. Domain\UserName) Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion Fill in all required parameters and set optional parameters if needed:
OdataDSNODataToken Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Token Fill-in the parameter... Optional Parameters AuthScheme Bearer AuthHeader Authorization RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion Fill in all required parameters and set optional parameters if needed:
OdataDSNODataOAuth Connection for OData API [OAuth]https://services.odata.org/V3/Northwind/Northwind.svcOptional Parameters GrantType Default OAuthVersion Default ClientId ClientSecret UserName Password Scope AuthUrl https://some-domain.com/api/auth TokenUrl https://some-domain.com/api/token ReturnUrl https://zappysys.com/oauth ExtraAttributesForTokenRequest ExtraAttributesForAuthRequest DoNotIncludeCredentialsInHeader DoNotIncludeCredentialsInBody RenewBeforeSec ExtraHeaders (e.g. x-hdr1:AAA||x-hdr2:BBB) ContentType EnableCodeVerifier RemoveAuthHeader CustomAuthHeader CustomTokenPrefix RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ODataOData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.OdataDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in SAP Crystal Reports to retrieve data from OData. Hit OK button to use this query in the next step.
SELECT * FROM Customers
Some parameters configured in this window will be passed to the OData API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in SAP Crystal Reports:
ZappySys API Driver - ODataOData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.OdataDSNSELECT * FROM Customers
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the OData API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in OData servers). -
Click OK to finish creating the data source.
Video Tutorial
Read data in SAP Crystal Reports from the ODBC data source
-
First of all, open SAP Crystal Reports and create the new Crystal Report.
-
And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select OdataDSN which we created in upper section. And Click on Next.
OdataDSN -
Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.
OdataDSNOdataDSN -
Add the desired Fields to Display in the Reports. Here we are adding all fields and click on Finish.
-
That's it and you will be able to load the data in the Report.
Using ZappySys Driver Custom Views and Stored Procedure in SAP Crystal Report
You can create parameterized Stored Procedure and Virtual Tables on the same Data Source (ODBC DSN or Data Gateway Data Source). Please refer to this article for the same. You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.Using Custom Views in the SAP Crystal Report
After establishing the connection with OdataDSN Data Source you can use the custom view in SQL Crystal Report.
Using Custom Stored Procedure in the SAP Crystal Report
-
First of all, create the custom stored procedure in the ZappySys Driver. Please refer to this article to create the custom stored procedure.
-
After establishing the connection with OdataDSN Data Source you can use the custom Stored Procedure in SQL Crystal Report. Same way you can write custom queries also in the query box.
OdataDSN
Actions supported by OData Connector
Learn how to perform common OData actions directly in SAP Crystal Reports with these how-to guides:
- Generic Read Data (JSON API)
- Generic Read Data (XML API)
- List Tables (JSON API)
- List Tables (XML API)
- Read [Dynamic Endpoint]
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to OData in SAP Crystal Reports and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to OData, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download OData Connector for SAP Crystal Reports and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download OData Connector for SAP Crystal Reports Documentation
More integrations
Other connectors for SAP Crystal Reports
Other application integration scenarios for OData
How to connect OData in SAP Crystal Reports?
How to get OData data in SAP Crystal Reports?
How to read OData data in SAP Crystal Reports?
How to load OData data in SAP Crystal Reports?
How to import OData data in SAP Crystal Reports?
How to pull OData data in SAP Crystal Reports?
How to push data to OData in SAP Crystal Reports?
How to write data to OData in SAP Crystal Reports?
How to POST data to OData in SAP Crystal Reports?
Call OData API in SAP Crystal Reports
Consume OData API in SAP Crystal Reports
OData SAP Crystal Reports Automate
OData SAP Crystal Reports Integration
Integration OData in SAP Crystal Reports
Consume real-time OData data in SAP Crystal Reports
Consume real-time OData API data in SAP Crystal Reports
OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination
Connect OData in SAP Crystal Reports
Load OData in SAP Crystal Reports
Load OData data in SAP Crystal Reports
Read OData data in SAP Crystal Reports
OData API Call in SAP Crystal Reports