XML File Connector for PowerShell

XML File Connector can be used to extract and output XML data stored in local XML files or direct XML String (variables or DB columns). XML Connector also supports Path expression to extract data from any level. This Connector is optimized to work with very large files.

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

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

Download Documentation

XML File Connector for PowerShell is based on ZappySys XML 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 XML Driver

Step-by-step instructions

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

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

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

You can use pass single file or multiple file path using wildcard pattern in path and you can use select single file by clicking [...] path button or multiple file using wildcard pattern in path.

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)

C:\SSIS\Test\reponse.xml (will read only single reponse.xml file)
C:\SSIS\Test\j*.xml (all files starting with file name j)
C:\SSIS\Test\*.xml (all files with .xml Extension and located under folder subfolder)

Now enter Path expression in Array Filter textbox to extract only specific part of XML file as below ($.feed.entry[*] will get content of entry attribute from XML document. Entry 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 Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.

$.feed.entry[*]
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
Click OK to finish creating the data source.
That's it; we are done. In a few clicks we configured the call to XML File using ZappySys XML File Connector.

Video Tutorial

Read XML File data in PowerShell

Sometimes, you need to quickly access and work with your XML File data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:

Viewing data in a terminal

Quickly peek at XML File data
Monitor data constantly in your console

Saving data to a file

Export data to a CSV file so that it can be sliced and diced in Excel
Export data to a JSON file so that it can ingested by other processes
Export data to an HTML file for user-friendly view and easy sharing
Create a schedule to make it an automatic process

Saving data to a database

Store data internally for analysis or for further ETL processes
Create a schedule to make it an automatic process

Sending data to another API

Integrate data with other systems via external APIs

In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!

Reading individual fields

Open your favorite PowerShell IDE (we are using Visual Studio Code).

Use this code snippet to read the data using XmlFileDSN data source:

"DSN=XmlFileDSN"

Read API data with PowerShell using ODBC DSN in Visual Code

For your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=XmlFileDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
$format = "{0}`t{1}`t{2}`t{3}"

# Display data in the console
foreach ($row in $table.Rows)
{
    # Construct line based on the format and individual XML File fields
    $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
    Write-Host $line
}

Access specific XML File table field using this code snippet:

$field = $row["ColumnName"]

You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.

For demonstration purposes we are using sample tables which may not be available in XML File.

To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
```
. 'C:\Users\john\Documents\dsn.ps1'
```

Retrieving all fields

However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

"DSN=XmlFileDSN"

Read all API columns from ODBC data source in PowerShell

Again, for your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=XmlFileDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Display data in the console
foreach ($row in $table.Rows) {
    $line = ""
    foreach ($column in $table.Columns) {
        $value = $row[$column.ColumnName]

        # Let's handle NULL values
        if ($value -is [DBNull])
        {
            $value = "(NULL)"
        }
        $line += $value + "`t"
    }
    Write-Host $line
}

You can limit the numbers of lines to retrieve by using a LIMIT keyword in the query, e.g.:

SELECT * FROM Customers LIMIT 10

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

Open ODBC data source configuration and click Copy settings:

ZappySys XML Driver - Configuration [Version: 2.0.1.10418]

ZappySys XML Driver - XML File

XML File Connector can be used to extract and output XML data stored in local XML files or direct XML String (variables or DB columns). XML Connector also supports Path expression to extract data from any level. This Connector is optimized to work with very large files.

XmlFileDSN
The window opens, telling us the connection string was successfully copied to the clipboard:
Then just paste the connection string into your script:
You are good to go! The script will execute the same way as using a DSN.

Write XML File data to a file in PowerShell

Save data to a CSV file

Export data to a CSV file so that it can be sliced and diced in Excel:

# Configure connection string and query
$connectionString = "DSN=XmlFileDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force

Save data to a JSON file

Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force

Save data to an HTML file

Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force

Check useful PowerShell cmdlets other than ConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.

Centralized data access via Data Gateway

In some situations, you may need to provide XML 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 XML File, and to create an ODBC data source to connect to Data Gateway in PowerShell.

Let's not wait and get going!

Creating XML File data source in Gateway

In this section we will create a data source for XML 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 XML Driver
- Finally, click OK
XmlFileDSN

ZappySys XML Driver
When the ZappySys XML 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 PowerShell. 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 XmlFileDSN (the one we used in Data Gateway):

XmlFileDSN
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 PowerShell via Data Gateway

Finally, we are ready to read data from XML File in PowerShell via Data Gateway. Follow these final steps:

Go back to PowerShell.

Use this code snippet to read the data using GatewayDSN data source:

"DSN=GatewayDSN"

For your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=GatewayDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
$format = "{0}`t{1}`t{2}`t{3}"

# Display data in the console
foreach ($row in $table.Rows)
{
    # Construct line based on the format and individual XML File fields
    $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
    Write-Host $line
}

Access specific XML File table field using this code snippet:

$field = $row["ColumnName"]

You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.

For demonstration purposes we are using sample tables which may not be available in XML File.

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

Now you can connect to XML File data in PowerShell 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.