XML Connector for SSISXML Connector can be used to extract and output XML data coming from REST API web service calls (Web URL) or direct XML String (variables or DB columns) or local XML files data. XML Connector also supports Path expression to extract data from any level. This Connector is optimized to work with very large XML string. In this article you will learn how to quickly and efficiently integrate XML data in SSIS without coding. We will use high-performance XML Connector to easily connect to XML and then access the data inside SSIS. Let's follow the steps below to see how we can accomplish that! XML Connector for SSIS is based on ZappySys Native SSIS Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
Connect to XML in other apps
|
Video Tutorial - Integrate XML data in SSIS
This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:
- How to download and install the required PowerPack for
XML integration in SSIS - How to configure the connection for
XML - Features of the
ZappySys XML Source (Authentication / Query Language / Examples / Driver UI) - How to use the
XML in SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Authentication
ZappySys offers various authentication methods to securely access data from various sources. These authentication methods include OAuth, Basic Authentication, Token-based Authentication, and more, allowing users to connect to a wide range of data sources securely.
ZappySys Authentication is a robust system that facilitates secure access to data from a diverse range of sources. It includes a variety of authentication methods tailored to meet the specific requirements of different data platforms and services. These authentication methods may involve:
OAuth: ZappySys supports OAuth for authentication, which allows users to grant limited access to their data without revealing their credentials. It's commonly used for applications that require access to user account information.
Basic Authentication: This method involves sending a username and password with every request. ZappySys allows users to securely access data using this traditional authentication approach.
Token-based Authentication: ZappySys enables users to utilize tokens for authentication. This method involves exchanging a unique token with each request to authenticate the user's identity without revealing sensitive information.
By implementing these authentication methods, ZappySys ensures the secure and reliable retrieval of data from various sources, providing users with the necessary tools to access and integrate data securely and efficiently. For more comprehensive details on the authentication process, please refer to the official ZappySys documentation or reach out to their support team for further assistance.
For more details, please refer to this link: ZappySys Connections
Read data from XML in SSIS using XML Source (Export data)
In this section we will learn how to configure and use XML Connector in the API Source to extract data from the XML using XML Source.
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and drop XML Source on the dataflow designer surface
-
Double click on XML Source component to configure it.
-
From the Access Mode dropdown select [File path or web Url] and paste the following Url for this example.
NOTE: Here for demo, We are using odata API, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type.https://www.w3schools.com/xml/plant_catalog.xml -
Now enter Path expression in Path textbox to extract only specific part of XML string as below ($.CATALOG.PLANT[*] will get content of plant attribute from XML document. Plant 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.
Click on Preview button to view the parsed XML string response data and click OK.$.CATALOG.PLANT[*]
-
That's it; we are done. In a few clicks we configured the call to XML using ZappySys XML Connector
Configuring pagination in the XML Source
ZappySys XML Source equips users with powerful tools for seamless data extraction and management from REST APIs, leveraging advanced pagination methods for enhanced efficiency. These options are designed to handle various types of pagination structures commonly used in APIs. Below are the detailed descriptions of these options:
Page-based Pagination: This method works by retrieving data in fixed-size pages from the Rest API. It allows you to specify the page size and navigate through the results by requesting different page numbers, ensuring that you can access all the data in a structured manner.
Offset-based Pagination: With this approach, you can extract data by specifying the starting point or offset from which to begin retrieving data. It allows you to define the number of records to skip and fetch subsequent data accordingly, providing precise control over the data extraction process.
Cursor-based Pagination: This technique involves using a cursor or a marker that points to a specific position in the dataset. It enables you to retrieve data starting from the position indicated by the cursor and proceed to subsequent segments, ensuring that you capture all the relevant information without missing any records.
Token-based Pagination: In this method, a token serves as a unique identifier for a specific data segment. It allows you to access the next set of data by using the token provided in the response from the previous request. This ensures that you can systematically retrieve all the data segments without duplication or omission.
Utilizing these comprehensive pagination features in the ZappySys XML Source facilitates efficient data management and extraction from REST APIs, optimizing the integration and analysis of extensive datasets.
For more detailed steps, please refer to this link: How to do REST API Pagination in SSIS / ODBC Drivers
Reading large XML string in SSIS (3 million rows in 3 mins)
Using ZappySys SSIS XML Source you can read large XML String data (Process 3 million rows in 3 minutes – 1.2 GB file). Using --FAST Expression and other options.
If you use default settings to read data then it may result into OutOfMemory Exception so we will outline few techniques which will enable high performance Streaming Mode rather than In-memory load of entire data.
Please refer to this article for the same: How to read large XML / JSON file in SSIS
Load XML data into SQL Server using Upsert Destination (Insert or Update)
Once you configured the data source, you can load XML data into SQL Server using Upsert Destination.
Upsert Destination can merge or synchronize source data with the target table.
It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets.
Upsert Destination also supports very fast bulk upsert operation along with bulk delete.
Upsert operation
- a database operation which performs INSERT or UPDATE SQL commands
based on record's existence condition in the target table.
It
Upsert Destination supports INSERT, UPDATE, and DELETE operations,
so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and XML data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
Done!
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:
Running SSIS package in Azure Data Factory (ADF)
To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:
Conclusion
In this article we showed you how to connect to XML in SSIS and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys XML Driver allows you to connect not only to XML, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download XML Connector for SSIS 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 XML Connector for SSIS Documentation
More integrations
Other connectors for SSIS
Other application integration scenarios for XML
How to connect XML in SSIS?
How to get XML data in SSIS?
How to read XML data in SSIS?
How to load XML data in SSIS?
How to import XML data in SSIS?
How to pull XML data in SSIS?
How to push data to XML in SSIS?
How to write data to XML in SSIS?
How to POST data to XML in SSIS?
Call XML API in SSIS
Consume XML API in SSIS
XML SSIS Automate
XML SSIS Integration
Integration XML in SSIS
Consume real-time XML data in SSIS
Consume real-time XML API data in SSIS
XML ODBC Driver | ODBC Driver for XML | ODBC XML Driver | SSIS XML Source | SSIS XML Destination
Connect XML in SSIS
Load XML in SSIS
Load XML data in SSIS
Read XML data in SSIS
XML API Call in SSIS