For the complete documentation index, see llms.txt. This page is also available as Markdown.

Azure SQL

The Azure SQL Agents allow you to include data from an Azure SQL database table into your stream.

The Listener allows you to return new rows added to a table. It operates on a timed interval and returns all new rows added to the table since the last interval.

The Context Provider allows you to read and output the entire contents of a table to the Data Stream for contextual data.

The Reader is similar to the Context Provider but has the added capability to filter using dynamic input from the Data Stream.

The Action Agent allows you to insert or update rows in a table, execute a stored procedure, or run a dynamic SELECT query. You can configure whether the destination table should be created before writing to it.

The Connector wraps the Azure SQL Connector functionality, allowing you to process data on an Azure SQL database as requested by an Application in App Designer via the XMPro Stream Connector.

Pre-requisites

SQL Server database credentials with appropriate permissions are required to use these Agents. The minimum XMPro Stream Host (SH) version required for these Agents v5.00+ is 4.3.7, i.e. download the SH installer from XMPro Data Stream Designer v4.3.7+.

Pre v5.00 of the Agents can only run on a Stream Host running on Windows.

Agent
Win. SH Pre 4.3.7
Linux SH Pre 4.3.7
Win. SH 4.3.7+
Linux SH 4.3.7+

v5.00+

Pre v5.00

Current Version

  • Download the Azure SQL Listener v6.10 (Last Update: 25 May 2026)

  • Download the Azure SQL Context Provider v6.11 (Last Update: 05 Jun 2026)

  • Download the Azure SQL Reader v1.00 (Last Update: 16 Oct 2025)

  • Download the Azure SQL Action Agent v6.10 (Last Update: 25 May 2026)

  • Download the Azure SQL Connector v2.27 (Last Update: 22 May 2026)

Please contact XMPro if you're looking for an older Agent version.

Listener Release Notes

Version
Date
Description

6.10

25 May 2026

Repackaged to fix incorrectly encoded translations introduced when packaging the ELS functionality.

6.00

17 Mar 2026

Support Event-Level Streaming (when using XMPro Platform v4.6+) for reduced memory usage and earlier downstream processing. Repackaged to translate missed dropdown properties.

5.53

11 Aug 2025

Support a variable for the database name.

5.52

08 May 2025

Support encryption (TrustServerCertificate) in the connection string. Resolved a vulnerability related to connection string injection. Improved error messages to give specific, user-friendly feedback. Breaking change - remove "; TrustServerCertificate=true" from the username only if you appended this as an encryption workaround.

5.51

22 Jan 2025

Repackaged to translate the Agent's properties.

5.50

29 Jul 2024

Updated Microsoft.Data.SqlClient from v5.1.1 to v5.2.1 for the CVE-2024-0056 security update.

Updated XMPro.IOT.Framework to v4.1.0.

5.00

03 Nov 2023

Updated System.Data.SqlClient to Microsoft.Data.SqlClient, which allows the Agent to run on a Windows or Linux Stream Host.

Breaking change - note the updated pre-requisites.

4.03

06 Sep 2022

Repackaged to include the Agent's Category.

4.02

05 Aug 2020

Not retaining the connection settings when switching from system variables to free text fields.

4.01

18 Jun 2020

XMP Error for Password Variable box fixed.

4.00

20 Apr 2020

Added option to specify connection settings using system Variables.

Using Connection Variables is the default setting from this version.

If upgrading the Agent in an existing Data Stream, you need to add the system variables first and then perform the variable mapping in the Data Stream.

3.11

09 Apr 2020

Catching errors from receive/poll and publishing to Error Endpoint.

3.10

22 Aug 2019

Added option to specify columns to return.

3.05

04 Mar 2019

Updated help url.

3.04

13 Aug 2018

Added Error Endpoint.

3.03

07 Aug 2018

Removed validation on Database to cater for sql logins that don't have access to query master database.

3.02

02 Aug 2018

Changed Database dropdown to allow custom values so that user can specify database name manually which is needed when login doesn't have permission to query master database.

Modified the error handling accordingly.

3.01

27 June 2018

Validation bug fixed.

3.00

06 June 2018

Initial Release.

Context Provider Release Notes

Version
Date
Description

6.11

05 Jun 2026

Fix single-line comments (--) in SQL queries being commented out at runtime, due to the agent replacing newlines with spaces.

Fix SQL queries failing when moved between Windows and Linux Stream Hosts, due to inconsistent newline handling across operating systems.

6.10

25 May 2026

Repackaged to fix incorrectly encoded translations introduced when packaging the ELS functionality.

6.00

17 Mar 2026

Support Event-Level Streaming (when using XMPro Platform v4.6+) for reduced memory usage and earlier downstream processing. Repackaged to translate missed dropdown properties.

5.53

11 Aug 2025

Support a variable for the database name.

5.52

May 2025

Support encryption (TrustServerCertificate) in the connection string. Resolved a vulnerability related to connection string injection. Improved error messages to give specific, user-friendly feedback. Breaking change - remove "; TrustServerCertificate=true" from the username only if you appended this as an encryption workaround.

5.51

22 Jan 2025

Repackaged to translate the Agent's properties.

5.50

29 Jul 2024

Updated Microsoft.Data.SqlClient from v5.1.1 to v5.2.1 for the CVE-2024-0056 security update.

Updated XMPro.IOT.Framework to v4.1.0.

5.00

03 Nov 2023

Updated System.Data.SqlClient to Microsoft.Data.SqlClient, which allows the Agent to run on a Windows or Linux Stream Host.

Breaking change - note the updated pre-requisites.

4.06

06 Sep 2022

Repackaged to include the Agent's Category.

4.05

19 Nov 2021

Fixed validation error when using SQL query option.

4.04

24 Aug 2021

Added option to specify SQL Query.

4.03

06 Oct 2020

Added option to limit the number of rows returned either by count or duration.

4.02

05 Aug 2020

Not retaining the connection settings when switching from system variables to free text fields.

4.01

28 Jul 2020

XMP Error for Password Variable box fixed.

4.00

20 Apr 2020

Added option to specify connection settings using system Variables.

Using Connection Variables is the default setting from this version.

If upgrading the Agent in an existing Data Stream, you need to add the system variables first and then perform the variable mapping in the Data Stream.

3.13

09 Apr 2020

Catching errors from receive/poll and publishing to Error Endpoint.

3.12

22 Oct 2019

Incorporate changes to Filter the Agent.

3.11

09 Sep 2019

Added filter option.

3.10

22 Aug 2019

Added option to specify columns to return and sort order.

3.05

04 Mar 2019

Updated help url.

3.04

13 Aug 2018

Added Error Endpoint.

3.03

07 Aug 2018

Removed validation on Database to cater for sql logins that don't have access to query master database.

3.02

02 Aug 2018

Changed Database dropdown to allow custom values so that user can specify database name manually which is needed when login doesn't have permission to query master database.

Modified the error handling accordingly.

3.01

27 June 2018

Validation bug fixed.

3.00

06 June 2018

Initial Release.

Reader (Action Agent) Release Notes

Version
Date
Description

1.00

16 Oct 2025

Initial Release.

Action Agent Release Notes

Version
Date
Description

6.10

25 May 2026

Repackaged to fix incorrectly encoded translations introduced when packaging the ELS functionality.

6.00

17 Mar 2026

Support Event-Level Streaming (when using XMPro Platform v4.6+) for reduced memory usage and earlier downstream processing. Repackaged to translate missed dropdown properties.

5.53

11 Aug 2025

Support a variable for the database name.

5.52

May 2025

Support encryption (TrustServerCertificate) in the connection string. Resolved a vulnerability related to connection string injection. Improved error messages to give specific, user-friendly feedback. Breaking change - remove "; TrustServerCertificate=true" from the username only if you appended this as an encryption workaround.

5.51

22 Jan 2025

Repackaged to translate the Agent's properties.

5.50

29 Jul 2024

Updated Microsoft.Data.SqlClient from v5.1.1 to v5.2.1 for the CVE-2024-0056 security update.

Updated XMPro.IOT.Framework to v4.1.0.

5.30

07 Jun 2024

Fixed issue with the Update action where new records were being created rather than updating.

5.20

16 Apr 2024

Added Dynamic SQL query support.

5.00

03 Nov 2023

Updated System.Data.SqlClient to Microsoft.Data.SqlClient, which allows the Agent to run on a Windows or Linux Stream Host.

Breaking change - note the updated pre-requisites.

4.41

06 Sep 2022

Repackaged to include the Agent's Category.

4.40

02 Feb 2022

Added config option to specify Command Timeout.

4.35

24 Nov 2021

Added SQL update support.

4.22

02 Feb 2021

Fixed issue with output parameters where the size was restricted by the input value.

4.21

04 Sep 2020

Fix for handling null values in the payload.

4.20

03 Sep 2020

Outputting original payload and added return type option when using stored proc.

4.12

05 Aug 2020

Not retaining the connection settings when switching from system variables to free text fields.

4.11

28 Jul 2020

XMP Error for Password Variable box fixed.

4.10

04 Jun 2020

Added stored proc functionality.

4.00

20 Apr 2020

Added option to specify connection settings using system Variables.

Using Connection Variables is the default setting from this version.

If upgrading the Agent in an existing Data Stream, you need to add the system variables first and then perform the variable mapping in the Data Stream.

3.10

04 Jun 2020

Added stored proc functionality (this version doesn't have system variables).

3.08

09 Apr 2020

Catching errors from receive/poll and publishing to Error Endpoint.

3.07

04 Mar 2019

Updated help url.

3.06

14 Aug 2018

Added Checkbox in config settings to allow firing database triggers on insert (if defined).

3.05

13 Aug 2018

Added Error Endpoint.

3.04

07 Aug 2018

Removed validation on Database to cater for sql logins that don't have access to query master database.

3.03

02 Aug 2018

Changed Database dropdown to allow custom values so that user can specify database name manually which is needed when login doesn't have permission to query master database.

Modified the error handling accordingly.

3.02

27 June 2018

Validation bug fixed.

3.01

13 Jun 2018

Batch Writing added.

3.00

06 June 2018

Initial Release.

Connector Release Notes

Version
Date
Description

2.27

22 May 2026

Decrypt context values received from the Stream Connector when encrypted, required for compatibility with App Designer v4.6.1+, so that sensitive credentials are no longer transmitted in plaintext.

Fixed the wrong Microsoft.Data.SqlClient binary being packaged, which caused a "not supported on this platform" error at runtime on non-Windows platforms.

2.26

17 Mar 2026

Initial Release (wraps the existing Azure SQL Connector). NOTE: Security concerns. Use v2.27+ with App Designer v4.6.1+.

Last updated

Was this helpful?