Getting Started with the CData PowerShell Cmdlets for XML Data

This guide explains everything you need to get started with the XML PowerShell Cmdlets. You'll learn how to install the cmdlets, configure your first connection, run queries, and explore next steps for working with XML data in PowerShell.

Installation & Licensing

System Requirements

CData PowerShell Cmdlets run anywhere PowerShell runs.

Windows

• Windows 10/11
• Windows Server 2016+
• PowerShell 5.1 or PowerShell 7+

macOS & Linux

• PowerShell 7+
• No additional system libraries required
• No architecture-specific installers

Installing the Cmdlets

CData Cmdlets are delivered through the PowerShell Gallery, ensuring a simple and consistent installation process across platforms.

Installation Steps

1. Open PowerShell in Administrator mode
2. Run the following command to install the cmdlet module:

   Install-Module XMLCmdlets -Repository PSGallery -Force

   This command:

   • Downloads the module from the official PowerShell Gallery
   • Installs it into your PowerShell environment
   • Registers all cmdlets for immediate use

Module Verification

To verify installation:

Get-Module -ListAvailable "*XML*"

Licensing

The cmdlets support both trial and fully licensed activation.

Trial Licensing

Trial activation is automatic - no key is required. Once installed, you can begin using the cmdlets immediately.

Activating a Full License

If you have purchased a full license, you will receive a product key from the CData Orders Team.

Activate Your License

Run the following command:

Set-ModuleLicense ""

You should see a confirmation message indicating successful activation.

Common Licensing Questions

Can I use my license on multiple machines?

Depending on your subscription tier. Refer to your order confirmation or contact [email protected].

I lost my license key. What do I do?

Email [email protected] with your order number to have it resent.

Can I transfer my license to another machine?

Submit a license transfer request here: https://www.cdata.com/lic/transfer/.

Where can I manage my license?

Visit the CData Customer Portal: https://portal.cdata.com/.

Connection Configuration

Once the module is installed and licensed, you can establish a connection to XML using the

Connect-XML cmdlet

After obtaining the needed connection properties, accessing XML data in PowerShell and preparing for replication consists of four basic steps.

Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) XML Files

CData Drivers let you work with XML files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

Setting connection properties for local files

Set the URI property to local folder path.

Setting connection properties for files stored in Amazon S3

To connect to XML file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended XML files exist. In addition, at least set these properties:

• AWSAccessKey: AWS Access Key (username)
• AWSSecretKey: AWS Secret Key

Setting connection properties for files stored in Box

To connect to XML file(s) within Box, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Box.

Dropbox

To connect to XML file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

SharePoint Online (SOAP)

To connect to XML file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. Set User, Password, and StorageBaseURL.

SharePoint Online REST

To connect to XML file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

Google Drive

To connect to XML file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

• Document (default): Model a top-level, document view of your XML data. The data provider returns nested elements as aggregates of data.
• FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
• Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling XML Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

Collecting XML Data

1. Install the module:

   Install-Module XMLCmdlets

2. Connect to XML:

     $xml = Connect-XML  -URI $URI -DataModel $DataModel
     

Querying XML Data in PowerShell

Once connected, you can query data using standard SQL like commands.

Example Query:

$results = Select-XML `
    -Connection $conn `
    -Table "people" `
    -Columns "[ personal.name.first ],[ personal.name.last ]" `
    -Where "[ personal.name.first ] != ''"

Display the results:

$results

You have now successfully accessed XML data from PowerShell!

Common Issues

Authentication Failed

Solution: Verify username, password, and security token. For OAuth applications, you may need to authorize CData in your application's security settings. Contact [email protected] for authorization assistance.

Network or Proxy Issues

Solution: Confirm firewall settings and outbound access. Most cloud applications use port 443.

Cmdlet Not Found

Solution: Ensure the module is installed-

Get-Module -ListAvailable "*XML*"

Slow Queries

Solution:

• Add filters to reduce dataset size
• Use $Limit or $Top properties where supported
• Contact [email protected] for optimization help

For additional connection troubleshooting, contact [email protected] with your specific error message.

What's Next?

Now that you have installed, licensed, and configured the PowerShell Cmdlets, here are some scenarios you can use to explore:

Get Support

If you need assistance:

• Technical Support: [email protected]
• Community Forum: CData Community Site
• Help Documentation: Installed locally and available online

FAQs (PowerShell Cmdlets)

Installation & Licensing

• Do I need administrator rights to install the cmdlets?

Not always.

• Windows PowerShell 5.1 (Windows): Administrator rights are recommended, especially when installing modules for all users.
• PowerShell 7+ (Windows, macOS, Linux): You can install cmdlets for the current user without admin rights using:

  Install-Module XMLCmdlets -Scope CurrentUser

• Do I need to download an installer?

CData PowerShell Cmdlets are delivered through the PowerShell Gallery. Installation is performed via:

Install-Module XMLCmdlets -Repository PSGallery -Force

Connecting

• How do I connect to multiple accounts for the same data source?

Create separate connection objects-each with different authentication properties:

$conn1 = Connect-XML -User User1 -Password Pwd1

$conn2 = Connect-XML -User User2 -Password Pwd2

• Does PowerShell Cmdlets require a DSN?

Cmdlets do not use ODBC DSNs. All connection properties are passed directly in

Connect-XML

• Can I connect through a proxy server?

Many cmdlets support proxy properties such as:

• ProxyServer
• ProxyPort
• ProxyUser
• ProxyPassword

Refer to the data-source-specific Help documentation.

Performance & Troubleshooting

• Why are my queries slow?

Common causes:

• Missing filters (e.g., no WHERE clause)
• Pulling large result sets
• Latency from cloud APIs
• Not using incremental strategies

Try:

• Filtering data (-Where parameter)
• Selecting only required columns
• Reviewing API throttling limits for your data source

Contact [email protected] for query optimization assistance.

• How do I enable logging?

Enable module logging with:

Set-ModuleLogging -Path "C:\logs\cdata.log" -Verbosity 3

Upload the log file securely when working with CData Support.
• What ports need to be open?

Most cloud applications (Salesforce, HubSpot, Dynamics, Google APIs, etc.) use: HTTPS (443)

If your source requires additional ports, check its specific documentation or contact [email protected].

• Can I use the cmdlets in containers (Docker, Kubernetes)?

Install PowerShell 7 in the container and install the module:

pwsh -Command "Install-Module XMLCmdlets -Force"

Then authenticate normally.

General

• Where can I find all supported SQL/command operations?

Each cmdlet includes a Help documentation set installed locally and available online: https://www.cdata.com/powershell/.

• How often are PowerShell Cmdlets updated?

CData releases major annual updates plus incremental updates throughout the year. Check your customer portal or contact [email protected] for version availability.

• Where can I find code examples?

Every Cmdlet includes examples in the Help documentation, plus online examples for many services: https://www.cdata.com/powershell/. Examples include:

• Basic queries
• Insert/update/delete
• OAuth flows
• File operations
• API integration

For questions not covered in this FAQ, [email protected].