How to integrate XML File using PowerShell

Integrate PowerShell and XML File
Integrate PowerShell and XML File

Learn how to quickly and efficiently connect XML File with PowerShell for smooth data access.

Read and write XML files effortlessly. Extract, filter, and sync XML from local files and strings for analytics, reporting, and data pipelines — almost no coding required. You can do it all using the high-performance XML File ODBC Driver for PowerShell (often referred to as the XML File Connector). We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Create data source using XML File ODBC Driver

Step-by-step instructions

To get data from XML File using PowerShell, we first need to create an ODBC data source. We will later read this data in PowerShell. Perform these steps:

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source

  3. Create a User data source (User DSN) based on the ZappySys XML Driver driver:

    ZappySys XML Driver
    Create new User DSN for ZappySys XML Driver
    • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
    • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this

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

  5. 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[*]
    ZappySys ODBC Driver - Configure XML Driver

  6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ZappySys ODBC Driver - Preview XML Driver

  7. Click OK to finish creating the data source.

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

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

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

  3. To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:

    Read API data in PowerShell using ODBC DSN
    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:

  1. Open ODBC data source configuration and click Copy settings:
    ZappySys XML Driver - Configuration [Version: 2.0.1.10418]
    ZappySys XML Driver - XML File
    Read and write XML files effortlessly. Extract, filter, and sync XML from local files and strings for analytics, reporting, and data pipelines — almost no coding required.
    XmlFileDSN
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then just paste the connection string into your script: Paste ODBC connection string in PowerShell to read API data
  4. 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.

Optional: Centralized data access via ZappySys 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

To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in PowerShell (client-side) to connect to it.

Let's not wait and get going!

Create XML File data source in the gateway

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

  1. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

    Open ZappySys Data Gateway Service Manager

  2. Go to the Users tab and follow these steps to add a Data Gateway user:

    • Click the Add button
    • In the Login field enter a username, e.g., john
    • Then enter a Password
    • Check the Is Administrator checkbox
    • Click OK to save
    Data Gateway - Add User

  3. Now we are ready to add a data source:

    • Click the Add button
    • Give the Data source a name (have it handy for later)
    • Then select Native - ZappySys XML Driver
    • Finally, click OK
    XmlFileDSN
    ZappySys XML Driver
    Data Gateway - Add data source

  4. When the ZappySys XML Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the XML File ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:

    • Open ODBC data source configuration and click Copy settings:
      ZappySys XML Driver - Configuration [Version: 2.0.1.10418]
      ZappySys XML Driver - XML File
      Read and write XML files effortlessly. Extract, filter, and sync XML from local files and strings for analytics, reporting, and data pipelines — almost no coding required.
      XmlFileDSN
      Copy connection string for ODBC application
    • The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application

    • Then go to Data Gateway configuration and in data source configuration window click Load settings:

      XmlFileDSN
      ZappySys XML Driver - Configuration [Version: 2.0.1.10418]
      ZappySys XML Driver - XML File
      Read and write XML files effortlessly. Extract, filter, and sync XML from local files and strings for analytics, reporting, and data pipelines — almost no coding required.
      XmlFileDSN
      Load configuration in ZappySys Data Gateway data source
    • Once a window opens, just paste the settings by pressing CTRL+V or by clicking right mouse button and then Paste option.

  5. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

    Data Gateway - Add firewall rule for inbound connections
    • This will initially allow all inbound traffic.
    • Click Edit IP filters to restrict access to specific IP addresses or ranges.

  6. Crucial Step: After creating or modifying the data source, you must:

    • Click the Save button to persist your changes.
    • Hit Yes when prompted to restart the Data Gateway service.

    This ensures all changes are properly applied:

    ZappySys Data Gateway - Save Changes
    Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Create ODBC data source to connect to the gateway

In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from PowerShell. To achieve that, let's perform these steps:

  1. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:

    ODBC Driver 17 for SQL Server
    Create new User DSN for ODBC Driver 17 for SQL Server
    If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version.

  3. Then set a Name for the data source (e.g. Gateway) and the address of the Data Gateway:

    ZappySysGatewayDSN
    localhost,5000
    ODBC driver for SQL Server - Setting hostname and port
    Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

  4. Proceed with the authentication part:

    • Select SQL Server authentication
    • In the Login ID field enter the user name you created in the Data Gateway, e.g., john
    • Set Password to the one you configured in the Data Gateway
    ODBC driver for SQL Server - Selecting SQL Authentication

  5. Then set the default database property to XmlFileDSN (the one we used in the Data Gateway):

    XmlFileDSN
    XmlFileDSN
    ODBC driver for SQL Server - Selecting database
    Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step).

  6. Continue by checking the Trust server certificate option:

    ODBC driver for SQL Server - Trusting certificate

  7. Once you do that, test the connection:

    ODBC driver for SQL Server - Testing connection

  8. If the connection is successful, everything is good:

    ODBC driver for SQL Server - Testing connection succeeded

  9. Done!

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

Access data in PowerShell via the gateway

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

  1. Go back to PowerShell.

  2. Use this code snippet to read the data using ZappySysGatewayDSN data source:

    "DSN=ZappySysGatewayDSN"
    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=ZappySysGatewayDSN"
$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.

  3. Read the data the same way we discussed at the beginning of this article.

  4. 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, SQL authentication or Basic authentication option and enter the credentials you used when configuring the Data Gateway, e.g. john and your password.

Conclusion

In this article we showed you how to connect to XML File in PowerShell and integrate data without writing complex code — all of this was powered by XML File ODBC Driver.

Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Download Chat

Explore PowerShell connectors

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

More XML File integrations

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