OneDrive Connector for SAP Crystal Reports

OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!

In this article you will learn how to quickly and efficiently integrate OneDrive data in SAP Crystal Reports without coding. We will use high-performance OneDrive Connector to easily connect to OneDrive and then access the data inside SAP Crystal Reports.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

OneDrive 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 OneDrive in other apps

Connect to OneDrive in SSIS

Connect to OneDrive in SQL Server

Connect to OneDrive in Power BI

Connect to OneDrive in SSRS

Connect to OneDrive in Informatica

Connect to OneDrive in MS Access

Connect to OneDrive in MS Excel

Connect to OneDrive in SSAS

Connect to OneDrive in C#

Connect to OneDrive in Python

Connect to OneDrive in JAVA

Connect to OneDrive in Tableau

Connect to OneDrive in Azure Data Factory (Pipeline)

Connect to OneDrive in Azure Data Factory (SSIS)

Connect to OneDrive in Talend Studio

Connect to OneDrive in UiPath

Connect to OneDrive in PowerShell

Connect to OneDrive in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from OneDrive using SAP Crystal Reports we first need to create a DSN (Data Source) which will access data from OneDrive. 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.
When the Configuration window appears give your data source a name if you haven't done that already, then select "OneDrive" from the list of Popular Connectors. If "OneDrive" 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:

OnedriveDSN

OneDrive

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.

User Credentials [OAuth]

Use delegated access (User Credentials) whenever you want to let a signed-in user work with their own resources or resources they can access. Whether it's an admin setting up policies for their entire organization or a user deleting an email in their inbox, all scenarios involving user actions should use delegated access. [API reference]

Steps how to get and use OneDrive credentials

Follow these simple steps below to create Microsoft Entra ID application with delegated access:

WARNING: To automate your company's processes, make sure you use a system/generic account (e.g. automation@my-company.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.

Navigate to the Azure Portal and log in using your credentials.
Access Microsoft Entra ID.
Register a new application by going to App registrations and clicking on New registration button:
INFO: Find more information on how to register an application in Graph API reference.
When configuration window opens, configure these fields:
- Supported account type
  - Use Accounts in this organizational directory only, if you need access to data in your organization only.
- Redirect URI:
  - Set the type to Public client/native (mobile & desktop).
  - Use https://zappysys.com/oauth as the URL.
After registering the app, copy the Application (client) ID for later:
Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs to use later in the configuration:
Now go to SSIS package or ODBC data source and use the copied values in User Credentials authentication configuration:
- In the Authorization URL field paste the OAuth authorization endpoint (v2) URL value you copied in the previous step.
- In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
- In the Client ID field paste the Application (client) ID value you copied in the previous step.
- In the Scope field use the default value or select individual scopes, e.g.:
  - email
  - offline_access
  - openid
  - profile
  - User.Read
  - Files.Read.All
  - Files.ReadWrite.All
Press Generate Token button to generate Access and Refresh Tokens.
Optional step. Choose Default Site Id from the drop down menu.
Click Test Connection to confirm the connection is working.
Done! Now you are ready to use the API Connector!

Fill in all required parameters and set optional parameters if needed:

OnedriveDSN

OneDrive

User Credentials [OAuth]

https://graph.microsoft.com/v1.0

Required Parameters
Authorization URL	Fill-in the parameter...
Token URL	Fill-in the parameter...
Client ID	Fill-in the parameter...
Scope	Fill-in the parameter...
Optional Parameters
Client Secret
Refresh Token File Path
Return URL	https://zappysys.com/oauth
Default Group or User Id (additional Scopes needed to list - If fails enter manually)
Default Drive Id (Select after clicking Generate Token)	me
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429\|503\|423
RetryCountMax	5
RetryMultiplyWaitTime	True
Login Prompt Option
Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed)
Extra Headers (e.g. Header1:AAA\|\|Header2:BBB)
IsAppCred	0

Application Credentials [OAuth]

Application-only access is broader and more powerful than delegated access (User Credentials), so you should only use app-only access where needed. Use it when: 1. The application needs to run in an automated way, without user input (for example, a daily script that checks emails from certain contacts and sends automated responses). 2. The application needs to access resources belonging to multiple different users (for example, a backup or data loss prevention app might need to retrieve messages from many different chat channels, each with different participants). 3. You find yourself tempted to store credentials locally and allow the app to sign in 'as' the user or admin. [API reference]

Steps how to get and use OneDrive credentials

Follow these simple steps below to create Microsoft Entra ID application with application access permissions. Using following steps, you can grant very granular app permissions to access Full site(s), List(s), List Item(s) and File(s). Choose permission based on your need.

Create OAuth app

Navigate to the Azure Portal and log in using your credentials.
Access Microsoft Entra ID.
Register a new application by going to App registrations and clicking on New registration button:
INFO: Find more information on how to register an application in Graph API reference.
When configuration window opens, configure these fields:
- Supported account type
  - e.g. select Accounts in this organizational directory only if you need access to data in your organization only.
- Redirect URI:
  - Set the type to Public client/native (mobile & desktop).
  - Leave the URL field empty.
After registering the app, copy the Application (client) ID for later:
Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs:
Continue and create Client secret:
Then copy the Client secret for later steps:
Continue by adding permissions for the app by going to the API permissions section, and clicking on Add a permission:
Select Microsoft Graph:
Then choose Application permissions option:
Continue by adding these Files (OneDrive) permissions (Just search for "Site" and then select desired permissions):
Move on by addding these Sites (SharePoint) permissions (You can search for "Site" and then select desired permissions):
Finish by clicking Add permissions button:
Now it's time to Grant admin consent for your application:
Confirm all the permissions are granted:
Now go to SSIS package or ODBC data source and use the copied values in Application Credentials authentication configuration:
- In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
- In the Client ID field paste the Application (client) ID value you copied in the previous step.
- In the Client Secret field paste the Client secret value you copied in the previous step.
- Optional step. Choose Default Site Id from the drop down menu.
Click Test Connection to confirm the connection is working.
Done! Let's move on to the next step.

Step-2 (Method#1 - New Approach): Grant permission to app using permission API (UI is not available yet)

In year 2024 microsoft launched

*.Selected

permission scopes and new APIs to grant granular permissions to the resource for app access scenario. Unfortunatly, there is no User interface available yet to control this access so you have to call Admin API or use PowerShell script to control this. [Click here to learn more]. Follow these simple steps to configure permissions for app we created earlier (steps assume you are the owner of the resource and like to grant some permissions e.g. read, write, full, owner):

Open PowerShell (Run as Admin user)
Install Graph API module by running this command
```
Import-Module Microsoft.Graph.Sites
```

Now you can call following PowerShell code to set "read" and "write" permission for the app we created earlier (assuming app id is 89ea5c94-7736-4e25-95ad-3fa95f62b66e).


#More info https://learn.microsoft.com/en-us/graph/permissions-selected-overview?tabs=powershell

#Step-1: Install module if not found
#Install-Module Microsoft.Graph.Sites

#Step-2: set permission for app 89xxx6e and site zappysys.xx.efcdd21xxxxe2
Import-Module Microsoft.Graph.Sites

#Step-3: Login
Connect-MgGraph

#Step-4: Set Parameters for API Call (set Permissions, SiteId and AppId - Replace under #TODO)

You can find SiteId by visiting this URL in browser (assuming you visted SharePoint site and already logged in) https://{your-company}.sharepoint.com/_api/site --OR-- for sub-site use https://{your-company}.sharepoint.com/sites/{your-site}/_api/site. Find  Id from the response (e.g. <Id m:type="Edm.Guid">)
$siteId="yourcompany.sharepoint.com,efcddxxxxxxx104d8b5e3,8c9c6xxxxxxxx84e2"
#--OR-- simple id
#$siteId="efcddxxxxxxx104d8b5e3"


$params = @{
	roles = @(
        #possible options are read, write, fullcontrol, owner (write includes read too)
		#TODO: Change here
		"write"
	)
	grantedTo = @{
		application = @{
            #find this Client Id (Application Id) from the Azure Portal - Application page (https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade)
			#TODO: Change here
			id = "c3e9xxxxxx-xxxxx-xxxxx-xxxx-xxxxxb30c1"
		}
	}
}

#Step-5: Grant Permission
New-MgSitePermission -SiteId $siteId -BodyParameter $params

Fill in all required parameters and set optional parameters if needed:

OnedriveDSN

OneDrive

Application Credentials [OAuth]

https://graph.microsoft.com/v1.0

Required Parameters
Token URL	Fill-in the parameter...
Client ID	Fill-in the parameter...
Client Secret	Fill-in the parameter...
Default Group or User Id (additional Scopes needed to list - If fails enter manually)	Fill-in the parameter...
Default Drive Id	Fill-in the parameter...
Optional Parameters
Scope	https://graph.microsoft.com/.default
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429\|503\|423
RetryCountMax	5
RetryMultiplyWaitTime	True
Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed)
Extra Headers (e.g. Header1:AAA\|\|Header2:BBB)
IsAppCred	1

Application Credentials with Certificate (Sign JWT with Private Key) [OAuth]

Steps how to get and use OneDrive credentials
To use Certificate-Based Authentication Setup please follow the steps listed in [Application Credentials] authentication and once done come back here to finish next stsps.

This guide walks you through setting up a certificate-based authentication flow for Microsoft Graph or other Azure AD protected APIs using client credentials and a JWT.

Step 1: Generate a Self-Signed Certificate

You can use OpenSSL or any other way to generate Certificate file but make it simple below example uses PowerShell. Open PowerShell and execute code listed in below steps.


# Run this in PowerShell
#Change .AddYears(1) to desired number. By default it expires certificate in one year as per below code.

$cert = New-SelfSignedCertificate `
  -Subject "CN=MyClientAppCert" `
  -KeySpec Signature `
  -KeyExportPolicy Exportable `
  -KeyLength 2048 `
  -CertStoreLocation "Cert:\CurrentUser\My" `
  -KeyAlgorithm RSA `
  -HashAlgorithm SHA256 `
  -NotAfter (Get-Date).AddYears(1) `
  -Provider "Microsoft Enhanced RSA and AES Cryptographic Provider"

# Export private key (.pfx)  - Keep this with you to make API calls (SECRET KEY - DONOT SHARE)
$pfxPath = "$env:USERPROFILE\Desktop\private_key.pfx"
$pwd = ConvertTo-SecureString -String "yourStrongPassword123" -Force -AsPlainText
Export-PfxCertificate -Cert $cert -FilePath $pfxPath -Password $pwd

# Export public certificate (.cer) - UPLOAD this to Azure Portal
$cerPath = "$env:USERPROFILE\Desktop\public_key.cer"
Export-Certificate -Cert $cert -FilePath $cerPath

Step 2: Register or Configure an App in Azure AD

Go to https://portal.azure.com
Navigate to Azure Active Directory > App registrations
Click + New registration or open an existing app
Copy the Application (client) ID and Directory (tenant) ID

Step 3: Upload the Certificate

In your App Registration, go to Certificates & secrets
Under Certificates, click Upload certificate
Select the .cer file (public certificate)
Click Add

Step 4: Grant API Permissions

Go to the API permissions tab
Click Add a permission
Select Microsoft Graph (or another API)
Choose Application permissions
Add scopes such as:
- Sites.Read.All
- Sites.ReadWrite.All
- Files.Read.All
- Files.ReadWrite.All
- email
- offline_access
- openid
- profile
- User.Read
Click Grant admin consent (requires admin)

Step 5: Use PFX file

Once both files generated perform the following steps to use PFX file., , Use the Certificate file (*.pfx) Now its time to use pfx file generated in the previous step. PFX file contains private key and public key both.

On ZappySys Connection UI Go to Certificate Tab
Change Storage Mode to Local PFX File (or you can Import PFX file in Certificate Storage - User Store / Machine Store and use that way)
Supply the pfx file path or select certificate from Local Certificate Store if you imported that way in earlier step
Supply the certificate password (same password used in earlier PowerShell script)
Test connection see everything is good

Fill in all required parameters and set optional parameters if needed:

OnedriveDSN

OneDrive

Application Credentials with Certificate (Sign JWT with Private Key) [OAuth]

https://graph.microsoft.com/v1.0

Required Parameters
Token URL	Fill-in the parameter...
Client ID	Fill-in the parameter...
Certificate: * Configure [Client Certificate] Tab *	Fill-in the parameter...
Default Site Id	Fill-in the parameter...
Optional Parameters
Default Drive Id
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429\|503\|423
RetryCountMax	5
RetryMultiplyWaitTime	True
Search Option For Non-Indexed Fields (Default=Blank - Search Only Indexed)
Extra Headers (e.g. Header1:AAA\|\|Header2:BBB)
IsAppCred	1

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 - OneDrive

OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!

OnedriveDSN
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 OneDrive. Hit OK button to use this query in the next step.
```
SELECT * FROM Files
```
Some parameters configured in this window will be passed to the OneDrive 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 data much 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 - OneDrive

OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!

OnedriveDSN
```
SELECT * FROM Files
```
You can also access data quickly from the tables dropdown by selecting <Select table>.

A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the OneDrive 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 OneDrive servers).
Click OK to finish creating the data source.

Video Tutorial

Watch this video on YouTube

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

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

OnedriveDSN

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

OnedriveDSN

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 OnedriveDSN 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.

OnedriveDSN