OneDrive Connector for Informatica

Introduction

JSON / REST API is becoming more and more popular each day as everyone embrace cloud-centric services. This article is primarily focused on Informatica users who want to access OneDrive data or may be other API Integration in Informatica. However many tips and techniques described in this article will help you to understand how to integrate OneDrive / XML SOAP / JSON / REST API in other ETL / Reporting apps such as Tableau, Power BI, SSRS, Talend, Excel and many more.

After going through this article you will learn how to Read OneDrive / JSON / REST API data in Informatica and understand the concept of JSON / REST API. We will go through many screenshots and step-by-step examples to demonstrate  OneDrive or REST API integration in Informatica PowerCenter.

XML / JSON can come from a local file or REST API service (internal or public) so we will include both examples in this article (i.e. Read JSON files in Informatica,  Import REST API in Informatica). So let’s get started. Next article will focus on how to write data to API in Informatica (POST / PUT data)

Requirements

This article assumes that you have full filled following basic requirements.

1. Download Install ZappySys ODBC PowerPack (API Driver for OneDrive included)
2. Install Informatica PowerCenter Client Tools (e.g. Workflow and Mapping Designers)
3. Access to a Relational database such as SQL Server (or use any of your choice e.g. Oracle, MySQL, DB2 ). If nothing available then you can use flat file target.

High level Steps for Import OneDrive data using Informatica (Read OneDrive API data)

Before we dive deep to learn how to load OneDrive data in Informatica (i.e. OneDrive to SQL Table), Here the summary of high-level steps you need to perform to import OneDrive in Informatica (same steps for Import JSON / XML / REST API).

1. Download and Install ZappySys API Driver (for connecting to OneDrive)
2. Create ODBC DSN using ZappySys API driver and choose OneDrive Connector during Wizard
3. Create Relational > ODBC Connection in Informatica Workflow designer (Point to DSN we created in the previous step)
4. Import OneDrive Source Definition in the Informatica Mapping Designer > Sources Tab
5. Import Target Table Definition in the Informatica Mapping Designer > Targets Tab
6. Create source to target mapping in Mappings tab
7. Save mapping (name m_API_to_SQL_Load )
8. Create Session using the mapping we created in the previous step
9. Save Workflow and execute to load OneDrive data into SQL Table. Verify your data and log.
   

   Loading OneDrive data to SQL Table in Informatica (Import REST API or JSON Files)

Video Tutorial – Read any API / JSON data in Informatica (Load OneDrive to SQL Table)

Getting Started – Import OneDrive to SQL Server in Informatica

Now let’s get started. For example purpose, we will read data from OneDrive and load data into SQL Server Table using Informatica Workflow.

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

Step-by-step instructions

To get data from OneDrive using Informatica we first need to create a DSN (Data Source) which will access data from OneDrive. We will later be able to read data using Informatica. Perform these steps:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys API Driver

   ZappySys API 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.

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

   

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

   1. Navigate to the Azure Portal and log in using your credentials.
   2. Access Microsoft Entra ID.
   3. 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.
   4. 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.
      
   5. After registering the app, copy the Application (client) ID for later:
   6. Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs to use later in the configuration:
   7. 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
   8. Press Generate Token button to generate Access and Refresh Tokens.
   9. Optional step. Choose Default Site Id from the drop down menu.
   10. Click Test Connection to confirm the connection is working.
   11. 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

   1. Navigate to the Azure Portal and log in using your credentials.
   2. Access Microsoft Entra ID.
   3. 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.
   4. 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.
      
   5. After registering the app, copy the Application (client) ID for later:
   6. Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs:
   7. Continue and create Client secret:
   8. Then copy the Client secret for later steps:
   9. Continue by adding permissions for the app by going to the API permissions section, and clicking on Add a permission:
   10. Select Microsoft Graph:
   11. Then choose Application permissions option:
   12. Continue by adding these Files (OneDrive) permissions (Just search for "Site" and then select desired permissions):
   13. Move on by addding these Sites (SharePoint) permissions (You can search for "Site" and then select desired permissions):
   14. Finish by clicking Add permissions button:
   15. Now it's time to Grant admin consent for your application:
   16. Confirm all the permissions are granted:
   17. 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.
   18. Click Test Connection to confirm the connection is working.
   19. 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):

   1. Open PowerShell (Run as Admin user)
   2. Install Graph API module by running this command

      Import-Module Microsoft.Graph.Sites

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

   

6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
   

7. Click OK to finish creating the data source.

Video instructions

Create Connection in Informatica Workflow Designer

Once you create DSN using API Driver our next step is to define a connection for OneDrive source in Informatica PowerCenter Workflow designer.

1. Open Workflow designer [W] icon
2. Goto Connections > Relational
   

   Create a new connection for OneDrive in Informatica

3. Click New and select ODBC
   

   Select ODBC connection type in Informatica (Using ZappySys API ODBC DSN)

4. Now on the ODBC connection setup enter connection name, some fake userid / password (this is a required field but its ignored by JSON Driver)
5. In the Connection String field enter the exact same name of DSN (Open ODBC Data Sources UI to confirm)
   

   Configure OneDrive connection in Informatica for REST API – Using ZappySys API Driver

6. Click OK to close the connection properties.

That’s it. Now we ready to move to next step (define source and target in Mapping Designer).

Import OneDrive Source Definition in Informatica Mapping Designer

Now let’s look at steps to import OneDrive table definition.

1. Open Informatica Mapping Designer (Click [D] icon)
2. Click on Source Icon to switch to Sources designer
3. From the top menu > Click on Sources > Import from Database …
   

   Import OneDrive Source definition in Informatica Mapping Designer (JSON file or REST API)

4. Select ODBC data source from the dropdown (Find out DSN we created earlier to use as JSON Source)
5. Click Connect button to get a list of tables. Any array node is listed as a table. Also, you will see array node with parent columns (e.g. value_with_parent). You may get some warning like below but they are harmless so just ignore by clicking OK.
   
   DLL name entry missing from C:\Informatica\PowerCenter8.6.1\client\bin\powrmart.ini Section = ODBCDLL Entry = ZappySys JSON Driver
   —————————————————-
   Using EXTODBC.DLL to support ZappySys JSON Driver. For native support of ZappySys JSON Driver make an entry in the .ini file.
   

   Select OneDrive Source Table in Informatica Mapping Designer (JSON file or REST API)

6. Select Table you wish to get (You can filter rows by custom SQL query. We will see later in this article how to do)
7. Optionally once table structure is imported you can rename it
   

   Rename imported table definition in Informatica Source Designer

8. That’s it, we are now ready to perform similar steps to import Target table structure in the next section.

Import SQL Server Target Definition in Informatica Mapping Designer

Now let’s look at steps to import Target table definition (very similar to the previous section, the only difference is this time we will select DSN which points to SQL Server or any other Target Server).