SAP Crystal Reports OData API Connector
In this article you will learn, how to integrate
Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connection and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.
If you are new with ODBC and ZappySys ODBC PowerPack then check below links to get started.
Create ODBC Data Source (DSN) based on ZappySys API Driver
To get data from OData using SAP Crystal Reports we first need to create a DSN - Data Source - which will access data from OData, which later will be able to get using SAP Crystal Reports. Perform these steps:
Install ZappySys ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User Data Source (User DSN) based on ZappySys API Driver:You should create System DSN if client application is launched under Windows System Account, e.g. as a Windows Service.
Launch ODBC Data Sources 32-bit version in case your client application is a 32-bit (x86) application (required only for System DSN).
When a window appears, firstly 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 one where you downloaded it. Finally, hit Continue >> button to continue configuring DSN:ODataDSNOData
Another window appears and it's time to configure the Connection Manager. Firstly, select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases default one is the right one). More info is available in Authentication section.
And finally, fill in all the required parameters and set optional parameters if needed.:ODataDSNNo Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svc
Required Parameters Optional Parameters
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
Click OK to finish creating the data source
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.
Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.
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 Store Procedure in SAP Crystal ReportYou 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 ReportAfter establishing the connection with ODataDSN Data Source you can use the custom view in SQL Crystal Report.
Using Custom Store Procedure in the SAP Crystal Report
First of all, create the custom store procedure in the ZappySys Driver. Please refer to this article to create the custom store procedure.
After establishing the connection with ODataDSN Data Source you can use the custom Store Procedure in SQL Crystal Report. Same way you can write custom queries also in the query box.
Create Custom Store Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders]
@fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
SELECT * FROM Orders where OrderDate >= '<@fromdate>'
That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01'
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
ConclusionIn this article we discussed how to connect to OData in SAP Crystal Reports and integrate data without any coding. Click here to Download OData Connector for SAP Crystal Reports and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Actions supported by OData ConnectorOData Connectors support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
Other App Integration scenarios for OData
Other API Connectors for SAP Crystal Reports
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 realtime 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