SAP Crystal Reports REST API Connector
In this article you will learn how to integrate Using REST API Connector you will be able to connect, read, and write data from within SAP Crystal Reports. Follow the steps below to see how we would accomplish that. 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 connections 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 to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
See also
|
Create ODBC Data Source (DSN) based on ZappySys JSON Driver
If your API is JSON Type and responding the json string response, in that case using ZappySys JSON Driver we can make the JSON API call and parse the json string. Let's configure the API call in the JSON Driver
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys JSON Driver
You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
Select Url or File and paste the following Url for this example.
NOTE: Here for demo, We are using odata API, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type
-
Now enter JSONPath expression in Array Filter textbox to extract only specific part of JSON file as below ($.value[*] will get content of value attribute from JSON document. Value attribute is array of JSON documents so we have to use [*] to indicate we want all records of that array)
NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.
Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.$.value[*] -
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
-
That's it; we are done. In a few clicks we configured the call to JSON API using ZappySys JSON Connector.
Create ODBC Data Source (DSN) based on ZappySys XML Driver
In upper section we we check how to make the JSON API call using JSON Driver and parse the json string response. Same way if your API is XML/SOAP Type and responding the xml string response, in that case using ZappySys XML Driver we can make the XML/SOAP API call and parse the xml string. Let's configure the API call in the XML Driver.
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys XML Driver
You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
Select Url or File and paste the following Url for this example.
NOTE: Here for demo, We are using odata API, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type
-
Now enter Path expression in Array Filter textbox to extract only specific part of XML file as below ($.feed.entry[*] will get content of entry attribute from XML document. Entry attribute is array of XML documents so we have to use [*] to indicate we want all records of that array)
NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.
Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.$.feed.entry[*] -
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.
-
That's it; we are done. In a few clicks we configured the call to XML API using ZappySys XML Connector.
Create ODBC Data Source (DSN) based on ZappySys CSV Driver
In upper section we we check how to make the XML/Soap API call using XML Driver and parse the xml string response. Same way if your API is csv Type or want to parse the CSV file data, in that case using ZappySys CSV Driver we can make the API call or read the CSV file data.
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys XML Driver
You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
Select Url or File.
Read CSV API in SAP Crystal Reports
-
Paste the following Url. In this example, We are using Zip format CSV File URL, but you need to refer your CSV File/URL.
https://zappysys.com/downloads/files/test/cust-1.csv.zipClick on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.
Read CSV File in SAP Crystal Reports
-
You can use pass single file or multiple file path using wildcard pattern in path and you can use select single file by clicking [...] path button or multiple file using wildcard pattern in path.
Note: If you want to operation with multiple files then use wild card pattern as below (when you use wild card pattern in source path then system will treat target path as folder regardless you end with slash) C:\SSIS\Test\reponse.csv (will read only single reponse.csv file) C:\SSIS\Test\j*.csv (all files starting with file name j) C:\SSIS\Test\*.csv (all files with .csv Extension and located under folder subfolder)
Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.
-
-
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
-
That's it; we are done. In a few clicks we configured the read the CSV data using ZappySys CSV Connector.
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 RestapiDSN which we created in upper section. And Click on Next.
RestapiDSN -
Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.
RestapiDSNRestapiDSN -
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 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 RestapiDSN 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 RestapiDSN 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.
RestapiDSN
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>>' AS 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';
-
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
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
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
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"
-
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.
Conclusion
In this article we discussed how to connect to REST API in SAP Crystal Reports and integrate data without any coding. Click here to Download REST API 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).
Download REST API Connector for SAP Crystal Reports
Documentation
Other App Integration scenarios for REST API
Other Connectors for SAP Crystal Reports
Download REST API Connector for SAP Crystal Reports
Documentation
How to connect REST API in SAP Crystal Reports?
How to get REST API data in SAP Crystal Reports?
How to read REST API data in SAP Crystal Reports?
How to load REST API data in SAP Crystal Reports?
How to import REST API data in SAP Crystal Reports?
How to pull REST API data in SAP Crystal Reports?
How to push data to REST API in SAP Crystal Reports?
How to write data to REST API in SAP Crystal Reports?
How to POST data to REST API in SAP Crystal Reports?
Call REST API API in SAP Crystal Reports
Consume REST API API in SAP Crystal Reports
REST API SAP Crystal Reports Automate
REST API SAP Crystal Reports Integration
Integration REST API in SAP Crystal Reports
Consume real-time REST API data in SAP Crystal Reports
Consume realtime REST API API data in SAP Crystal Reports
REST API ODBC Driver | ODBC Driver for REST API | ODBC REST API Driver | SSIS REST API Source | SSIS REST API Destination
Connect REST API in SAP Crystal Reports
Load REST API in SAP Crystal Reports
Load REST API data in SAP Crystal Reports
Read REST API data in SAP Crystal Reports
REST API API Call in SAP Crystal Reports