Create ODBC Data Source (DSN) based on ZappySys Amazon S3 XML Driver

Step-by-step instructions

To get data from Amazon S3 XML File using SAP Crystal Reports we first need to create a DSN (Data Source) which will access data from Amazon S3 XML File. We will later be able to read data using SAP Crystal Reports. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys Amazon S3 XML Driver:

   ZappySys Amazon S3 XML 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.

4. Create and configure a connection for the Amazon S3 storage account.

   

5. You can use select your desired single file by clicking [...] path button.

   mybucket/dbo.tblNames.xml

   dbo.tblNames.xml

   
   
   
   ----------OR----------

   You can also read the multiple files stored in Amazon S3 Storage using wildcard pattern supported e.g. dbo.tblNames*.xml.
   

   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)
   
   mybucket/dbo.tblNames.xml (will read only single .XML file)
   mybucket/dbo.tbl*.xml (all files starting with file name)
   mybucket/*.xml (all files with .xml Extension and located under folder subfolder)
   

   mybucket/dbo.tblNames*.xml

   
   
   
   ----------OR----------

   You can also read the zip and gzip compressed files also without extracting it in using Amazon S3 XML Source File Task.

   mybucket/dbo.tblNames*.gz

   

6. Now select/enter Path expression in Path textbox to extract only specific part of XML string as below ($.value[*] will get content of value attribute from XML document. Value 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.
   

7. Navigate to the Preview Tab and let's explore the different modes available to access the data.
   

   1. --- Using Direct Query ---

      Click on Preview Tab, Select Table from Tables Dropdown and select [value] and click Preview.
      

   2. --- Using Stored Procedure ---

      Note : For this you have to Save ODBC Driver configuration and then again reopen to configure same driver. For more information click here.
      

      Click on the Custom Objects Tab, Click on Add button and select Add Procedure and Enter an appropriate name and Click on OK button to create.
      

      1. --- Without Parameters ---

         Now Stored Procedure can be created with or without parameters (see example below). If you use parameters then Set default value otherwise it may fail to compilation)
         
         

      2. --- With Parameters ---

         Note : Here you can use Placeholder with Paramters in Stored Procedure.
         Example : SELECT * FROM $ WHERE OrderID = '<@OrderID, FUN_TRIM>' or CustId = '<@CustId>' and Total >= '<@Total>'
         

         

   3. --- Using Virtual Table ---

      Note : For this you have to Save ODBC Driver configuration and then again reopen to configure same driver. For more information click here.
      

      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 Buckets with slight variations you can create virtual tables with just URL as Parameter setting).

      vt__Customers
      DataPath=mybucket_1/customers.xml
      
      vt__Orders
      DataPath=mybucket_2/orders.xml
      
      vt__Products
      DataPath=mybucket_3/products.xml
      

      1. Click on the Custom Objects Tab, Click on Add button and select Add Table and Enter an appropriate name and Click on OK button to create.
         
      2. Once you see Query Builder Window on screen Configure it.
         
      3. Click on Preview Tab, Select Virtual Table(prefix with vt__) from Tables Dropdown or write SQL query with Virtual Table name and click Preview.
         

8. Click OK to finish creating the data source

9. That's it; we are done. In a few clicks we configured the to Read the Amazon S3 XML File data using ZappySys Amazon S3 XML File Connector

Read data in SAP Crystal Reports from the ODBC data source

1. First of all, open SAP Crystal Reports and create the new Crystal Report.

   

2. 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 AmazonS3XmlFileDSN which we created in upper section. And Click on Next.

   AmazonS3XmlFileDSN

   

3. Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.

   AmazonS3XmlFileDSN

   AmazonS3XmlFileDSN

   

4. Add the desired Fields to Display in the Reports. Here we are adding all fields and click on Finish.

   

5. 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 AmazonS3XmlFileDSN Data Source you can use the custom view in SQL Crystal Report.

Using Custom Stored Procedure in the SAP Crystal Report

1. First of all, create the custom stored procedure in the ZappySys Driver. Please refer to this article to create the custom stored procedure.
   
2. After establishing the connection with AmazonS3XmlFileDSN 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.
   AmazonS3XmlFileDSN

   

Centralized data access via Data Gateway

In some situations, you may need to provide Amazon S3 XML File data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

• Centralized data access
  The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
• Centralized access control
  Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

	Data Gateway	Local ODBC data source
Simple configuration
Installation	Single machine	Per machine
Connectivity	Local and remote	Local only
Connections limit	Limited by License	Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Amazon S3 XML File, and to create an ODBC data source to connect to Data Gateway in SAP Crystal Reports.

Let's not wait and get going!

Creating Amazon S3 XML File data source in Gateway

In this section we will create a data source for Amazon S3 XML File in Data Gateway. Let's follow these steps to accomplish that:

1. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

   

2. Go to Users tab and follow these steps to add a Data Gateway user:

   • Click Add button
   • In Login field enter username, e.g., john
   • Then enter a Password
   • Check Is Administrator checkbox
   • Click OK to save
   

3. Now we are ready to add a data source:

   • Click Add button
   • Give Datasource a name (have it handy for later)
   • Then select Native - ZappySys Amazon S3 XML Driver
   • Finally, click OK
   AmazonS3XmlFileDSN

   ZappySys Amazon S3 XML Driver

   

4. When the ZappySys Amazon S3 XML Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.

5. Very important step. Now, after creating or modifying the data source make sure you:

   • Click the Save button to persist your changes.
   • Hit Yes, once asked if you want to restart the Data Gateway service.

   This will ensure all changes are properly applied:

   
   Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from SAP Crystal Reports. To achieve that, let's perform these steps:

1. Open ODBC Data Sources (x64):

   

2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

   ODBC Driver 17 for SQL Server

   
   If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.

3. Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

   GatewayDSN

   localhost,5000

   
   Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

4. Proceed with authentication part:

   • Select SQL Server authentication
   • In Login ID field enter the user name you used in Data Gateway, e.g., john
   • Set Password to the one you configured in Data Gateway
   

5. Then set the default database property to AmazonS3XmlFileDSN (the one we used in Data Gateway):

   AmazonS3XmlFileDSN

   

6. Continue by checking Trust server certificate option:

   

7. Once you do that, test the connection:

   

8. If connection is successful, everything is good:

   

9. Done!

We are ready to move to the final step. Let's do it!

Accessing data in SAP Crystal Reports via Data Gateway

Finally, we are ready to read data from Amazon S3 XML File in SAP Crystal Reports via Data Gateway. Follow these final steps:

1. Go back to SAP Crystal Reports.

2. First of all, open SAP Crystal Reports and create the new Crystal Report.

   

3. 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 GatewayDSN which we created in upper section. And Click on Next.

   GatewayDSN

   

4. Read the data the same way we discussed at the beginning of this article.

5. That's it!

Now you can connect to Amazon S3 XML File data in SAP Crystal Reports via the Data Gateway.

Conclusion

In this article we showed you how to connect to Amazon S3 XML File in SAP Crystal Reports and integrate data without any coding, saving you time and effort.

We encourage you to download Amazon S3 XML File 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 Amazon S3 XML File Connector for SAP Crystal Reports Documentation

More integrations

Other connectors for SAP Crystal Reports

Other application integration scenarios for Amazon S3 XML File