FTP/SFTP JSON File Connector for Azure Data Factory (Pipeline)

FTP/SFTP JSON File Connector can be used to read JSON Files stored on FTP Sites (Classic FTP, SFTP or FTPS). Using this you can easily read FTP/SFTP JSON File data. It's supports latest security standards, and optimized for large data files. It also supports reading compressed files (e.g. GZip /Zip).

In this article you will learn how to quickly and efficiently integrate FTP/SFTP JSON File data in Azure Data Factory (Pipeline) without coding. We will use high-performance FTP/SFTP JSON File Connector to easily connect to FTP/SFTP JSON File and then access the data inside Azure Data Factory (Pipeline).

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

Download Documentation

FTP/SFTP JSON File Connector for Azure Data Factory (Pipeline) is based on ZappySys SFTP JSON 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.

Create ODBC Data Source (DSN) based on ZappySys SFTP JSON Driver

Step-by-step instructions

To get data from FTP/SFTP JSON File using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from FTP/SFTP JSON File. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:

Download and install ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ZappySys SFTP JSON Driver:

ZappySys SFTP JSON 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.
Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN.
Create and configure a connection for the FTP/SFTP storage account.
You can use select your desired single file by clicking [...] path button.

mybucket/dbo.tblNames.json

dbo.tblNames.json

----------OR----------
You can also read the multiple files stored in FTP/SFTP Storage using wildcard pattern supported e.g. dbo.tblNames*.json.
```
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.json (will read only single .JSON file)
mybucket/dbo.tbl*.json (all files starting with file name)
mybucket/*.json (all files with .json Extension and located under folder subfolder)
```
mybucket/dbo.tblNames*.json

----------OR----------
You can also read the zip and gzip compressed files also without extracting it in using FTP/SFTP JSON Source File Task.

mybucket/dbo.tblNames*.gz
Now select/enter Path expression in Path textbox to extract only specific part of JSON string 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.
Go to Preview Tab.
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.json

vt__Orders
DataPath=mybucket_2/orders.json

vt__Products
DataPath=mybucket_3/products.json
```
  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.
Click OK to finish creating the data source
That's it; we are done. In a few clicks we configured the to Read the FTP/SFTP JSON File data using ZappySys FTP/SFTP JSON File Connector

Read data in Azure Data Factory (ADF) from ODBC datasource (FTP/SFTP JSON File)

Sign in to Azure Portal
- Open your browser and go to: https://portal.azure.com
- Enter your Azure credentials and complete MFA if required.
- After login, go to Data factories.
Under Azure Data Factory Resource - Create or select the Data Factory you want to work with.
Inside the Data Factory resource page, click Launch studio.
Create a New Integration Runtime (Self-Hosted):
- In Azure Data Factory Studio, go to the Manage section (left menu).
- Under Connections, select Integration runtimes.
- Click + New to create a new integration runtime.
Select Azure, Self-Hosted option:
Select Self-Hosted option:
Set a name, we will use OnPremisesRuntime:
Download and install Microsoft Integration Runtime.
Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:
After finishing registering the Integration Runtime node, you should see a similar view:
Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:
Create a New Linked service:
- In the Manage section (left menu).
- Under Connections, select Linked services.
- Click + New to create a new Linked service based on ODBC.
Select ODBC service:
Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

FtpSftpJsonFileDSN

DSN=FtpSftpJsonFileDSN
For created ODBC service create ODBC-based dataset:
Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:
Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:
Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

Executing SQL queries using Lookup activity

If you need to execute commands in FTP/SFTP JSON File instead of retrieving data, use the Lookup activity for that purpose. Use this approach when you want data to be changed on the FTP/SFTP JSON File side, but you don't need the data on your side (a "fire-and-forget" scenario).

Perform these simple steps to accomplish that:

Go to your pipeline in Azure Data Factory
Find Lookup activity in the Activities pane
Then drag-and-drop the Lookup activity onto your pipeline canvas
Click Settings tab
Select OdbcDataset in the Source dataset field
Finally, enter your SQL query in the Query text box:

SELECT * FROM delete_attachment WITH ( "attachment_id" = 'abcd-1234-attachment_id' )

Configuring Lookup activity in ADF pipeline to perform a command in FTP/SFTP JSON File

Centralized data access via Data Gateway

In some situations, you may need to provide FTP/SFTP JSON 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 FTP/SFTP JSON File, and to create an ODBC data source to connect to Data Gateway in Azure Data Factory (Pipeline).

Let's not wait and get going!

Creating FTP/SFTP JSON File data source in Gateway

In this section we will create a data source for FTP/SFTP JSON File in Data Gateway. Let's follow these steps to accomplish that:

Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:
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
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 SFTP JSON Driver
- Finally, click OK
FtpSftpJsonFileDSN

ZappySys SFTP JSON Driver
When the ZappySys SFTP JSON 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.
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 Azure Data Factory (Pipeline). To achieve that, let's perform these steps:

Open ODBC Data Sources (x64):
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.
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.
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
Then set the default database property to FtpSftpJsonFileDSN (the one we used in Data Gateway):

FtpSftpJsonFileDSN
Continue by checking Trust server certificate option:
Once you do that, test the connection:
If connection is successful, everything is good:
Done!

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

Accessing data in Azure Data Factory (Pipeline) via Data Gateway

Finally, we are ready to read data from FTP/SFTP JSON File in Azure Data Factory (Pipeline) via Data Gateway. Follow these final steps:

Go back to Azure Data Factory (Pipeline).
Create a New Linked service:
- In the Manage section (left menu).
- Under Connections, select Linked services.
- Click + New to create a new Linked service based on ODBC.
Select ODBC service:
Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

GatewayDSN

DSN=GatewayDSN
Read the data the same way we discussed at the beginning of this article.
That's it!

Now you can connect to FTP/SFTP JSON File data in Azure Data Factory (Pipeline) via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.

Conclusion

In this article we showed you how to connect to FTP/SFTP JSON File in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort.

We encourage you to download FTP/SFTP JSON File Connector for Azure Data Factory (Pipeline) 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 FTP/SFTP JSON File Connector for Azure Data Factory (Pipeline) Documentation