OData Connector for Informatica

OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.

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

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

Download Documentation

Introduction

Informatica PowerCenter Logo 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 OData 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 OData / 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 OData / 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  OData 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)

If you need to consume API which is not listed on connector library page then please refer to the below article links. It talks about how to read / write pretty much any API and not just OData API. It explains various API tips / tricks using our other Universal Drivers not mentioned in this article (i.e. ZappySys JSON / XML and CSV Drivers).

Requirements

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

  1. Download Install ZappySys ODBC PowerPack (API Driver for OData 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 OData data using Informatica (Read OData API data)

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

  1. Download and Install ZappySys API Driver (for connecting to OData)
  2. Create ODBC DSN using ZappySys API driver and choose OData Connector during Wizard
  3. Create Relational > ODBC Connection in Informatica Workflow designer (Point to DSN we created in the previous step)
  4. Import OData 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 OData data into SQL Table. Verify your data and log.
    Loading JSON data to SQL Table in Informatica (Import OData / REST API / JSON Files)

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

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

Below video is not about OData API but its showing API access in general (for any API). By watching following ~5 min video can learn steps listed in this article to load JSON API data into SQL Server Table using ZappySys JSON Driver. You can go though full article to learn many useful details not covered in this video.

Getting Started – Import OData to SQL Server in Informatica

Now let’s get started. For example purpose, we will read data from OData 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 OData using Informatica we first need to create a DSN (Data Source) which will access data from OData. We will later be able to read data using Informatica. Perform these steps:

  1. Download and install ODBC PowerPack.

  2. Open ODBC Data Sources (x64):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for 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.
  4. When the Configuration window appears 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 location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    OdataDSN
    OData
    ODBC DSN Template Selection
  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.

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

    OdataDSN
    OData
    No Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    IgnoreSSLCertificateErrors
    SslVersion
    ODBC DSN HTTP Connection Configuration

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

    OdataDSN
    OData
    Windows Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    This Authentication Type has no parameters to fill-in.
    ODBC DSN HTTP Connection Configuration

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

    OdataDSN
    OData
    Basic Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName Fill-in the parameter...
    Password Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    IgnoreSSLCertificateErrors
    SslVersion
    ODBC DSN HTTP Connection Configuration

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

    OdataDSN
    OData
    NTLM Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    UserName (i.e. Domain\UserName) Fill-in the parameter...
    Password Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    IgnoreSSLCertificateErrors
    SslVersion
    ODBC DSN HTTP Connection Configuration

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

    OdataDSN
    OData
    Token Authentication [Http]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Required Parameters
    Token Fill-in the parameter...
    Optional Parameters
    AuthScheme Bearer
    AuthHeader Authorization
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    IgnoreSSLCertificateErrors
    SslVersion
    ODBC DSN HTTP Connection Configuration

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

    OdataDSN
    OData
    OAuth Connection for OData API [OAuth]
    https://services.odata.org/V3/Northwind/Northwind.svc
    Optional Parameters
    GrantType Default
    OAuthVersion Default
    ClientId
    ClientSecret
    UserName
    Password
    Scope
    AuthUrl https://some-domain.com/api/auth
    TokenUrl https://some-domain.com/api/token
    ReturnUrl https://zappysys.com/oauth
    ExtraAttributesForTokenRequest
    ExtraAttributesForAuthRequest
    DoNotIncludeCredentialsInHeader
    DoNotIncludeCredentialsInBody
    RenewBeforeSec
    ExtraHeaders (e.g. x-hdr1:AAA||x-hdr2:BBB)
    ContentType
    EnableCodeVerifier
    RemoveAuthHeader
    CustomAuthHeader
    CustomTokenPrefix
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    IgnoreSSLCertificateErrors
    SslVersion
    ODBC DSN Oauth Connection Configuration

  6. 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 - OData
    OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.
    OdataDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  7. 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 Informatica to retrieve data from OData. Hit OK button to use this query in the next step.

    SELECT * FROM Customers
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the OData 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.
  8. 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 Informatica:

    ZappySys API Driver - OData
    OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.
    OdataDSN
    SELECT * FROM Customers
    API ODBC Driver-based data source data preview
    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 OData 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 OData servers).
  9. Click OK to finish creating the data source.

Video Tutorial

Create Connection in Informatica Workflow Designer

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

  1. Open Workflow designer [W] icon
  2. Goto Connections > Relational
    Create new connection for JSON in Informatica

    Create a new connection for OData in Informatica

  3. Click New and select ODBC
    Select ODBC connection type in Informatica (Using ZappySys JSON ODBC DSN)

    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 OData connection in Informatica for REST API – Using ZappySys API ODBC Driver

    Configure OData 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 OData Source Definition in Informatica Mapping Designer

Now let’s look at steps to import OData 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 JSON Source definition in Informatica Mapping Designer (JSON file or REST API)

    Import OData 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 JSON Source Table in Informatica Mapping Designer (JSON file or REST API)

    Select OData 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

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

Now lets look at steps to import target table definition in Informatica mapping designer.

  1. In the Mapping Designer, Click on Target Icon to switch to Target designer
  2. From the top menu > Click on Targets > Import from Database
  3. Select DSN for your Target server (if DSN doesn’t exist then create one by opening ODBC Sources just like we created one for JSON API source (see the previous section about creating DSN).
    Import target Table Definition in informatica

    Import target Table Definition in informatica

  4. Enter your userid , password and Schema name and click Connect to see tables
  5. Select Table name to and click OK import definition.
    Import Target SQL Table Definition in Informatica - Select table from the list

    Import Target SQL Table Definition in Informatica – Select table from the list

Create Source to Target Mapping in Informatica (Import JSON to SQL Server)

Once you have imported source and target table definition, we can create mapping and transformation to load data from JSON to SQL Table.

  1. First open Mapping Designer (Click [D] icon)
  2. Drag JSON Source from sources folder
  3. Drag SQL Table from Targets folder
  4. Map desired columns from Source to target
    Define Source to Target mapping for JSON to SQL Table load in Informatica

    Define Source to Target mapping for OData to SQL Table load in Informatica

  5. For certain columns you may have to do datatype conversion. For example to convert OrderDate form nstring to DataTime you have to use Expression Transform like below and map it to target. In below example, our JSON has date format (e.g. 2018-01-31 12:00:00 AM ). To import this to DateTime field in SQL server we need to convert it using TO_DATE function. Use double quotes around T to make this format working.
    TO_DATE(OrderDate,'YYYY-MM-DD H12:MI:SS AM')
    
     --For ISO use below way
            TO_DATE(OrderDate,'YYYY-MM-DD"T"HH24:MI:SS')
    Informatica JSON to SQL Table Mapping - Datatype conversion (nstring to datetime)

    Informatica OData to SQL Table Mapping – Datatype conversion (nstring to datetime)

  6. Once you done with mapping save your mapping and name it (i.e. m_Api_To_SQL)
  7. Now lets move to next section to create workflow.

Create Workflow and Session in Informatica

Now the final step is to create a new workflow. Perform following steps to create workflow which with a session task to import JSON data into SQL table.

  1. Open workflow designer by click [W] icon.
  2. Launch new workflow creation wizard by click Workflow top menuWizard
    name your workflow (e.g. wf_Api_Tp_Sql_Table_Import)

    Creating Informatica Workflow - Wizard UI (Import JSON data to SQL Table)

    Creating Informatica Workflow – Wizard UI (Import OData data to SQL Table)

  3. Finish the wizard and double-click the Session to edit some default properties.
  4. First change Error settings so we fail session on error (By default its always green)
    Fail Informatica Session on error (JSON to SQL Load)

    Fail Informatica Session on error (OData data to SQL Load)

  5. Select JSON connection for Source
    Select JSON Source Connection in Informatica - JSON File / REST API Load to SQL Table

    Select OData Source Connection in Informatica – Load OData data to SQL Table

  6. Change default Source query if needed. You can pass parameters to this query to make it dynamic.
    Modify JSON Source SQL query - Pass parameters, change URL, set filter etc

    Modify OData Source SQL query – Pass parameters, change URL, set filter etc

  7. Select Target connection of SQL Target Table
    Select SQL Target Connection in Informatica - JSON File / REST API Load to SQL Table

    Select SQL Target Connection in Informatica – Load OData data to SQL Table

  8. Save workflow
  9. That’s it. We ready to run our first workflow to load JSON data to SQL.

Execute Workflow and Validate Log in Informatica

Now once you are done with your workflow, execute it to see the log.

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

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

 

POST data to OData in Informatica

There will be a time when you like to send Source data to REST API or SOAP Web Service. You can use below Query for example. For detailed explanation on how to POST data in Informatica check this article .

Video Tutorial – How to POST data to REST API in Informatica

Here is detailed step by step video on REST API POST in informatica PowerCenter

 

Keywords

how to import OData in informatica | how to read OData data in informatica powercenter | how to test json from informatica | how to use OData data as source in informatica power center | how to connect OData in informatica 10 | informatica how to import data from OData | informatica jtx to import OData (use of java transformation) | informatica plugin for restful api using json | informatica power center and OData support | informatica read OData | informatica rest api | informatica OData connector | json parser import informatica

Actions supported by OData Connector

Learn how to perform common OData actions directly in Informatica with these how-to guides:

Conclusion

In this article we showed you how to connect to OData in Informatica and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to OData, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download OData Connector for Informatica 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 OData Connector for Informatica Documentation

More integrations

Other connectors for Informatica

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for OData

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

  • How to connect OData in Informatica?

  • How to get OData data in Informatica?

  • How to read OData data in Informatica?

  • How to load OData data in Informatica?

  • How to import OData data in Informatica?

  • How to pull OData data in Informatica?

  • How to push data to OData in Informatica?

  • How to write data to OData in Informatica?

  • How to POST data to OData in Informatica?

  • Call OData API in Informatica

  • Consume OData API in Informatica

  • OData Informatica Automate

  • OData Informatica Integration

  • Integration OData in Informatica

  • Consume real-time OData data in Informatica

  • Consume real-time OData API data in Informatica

  • OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination

  • Connect OData in Informatica

  • Load OData in Informatica

  • Load OData data in Informatica

  • Read OData data in Informatica

  • OData API Call in Informatica