SQL Server
The SQL Server Agents allow you to include data from a SQL Server database table into your Data 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.
Pre-requisites
Azure SQL database credentials with appropriate permissions are required to use these Agents.
The minimum XMPro Stream Host (SH) version required for these Agents v5.00 or later is 4.3.7, i.e. download the SH installer from XMPro Data Stream Designer v4.3.7 or later.
Pre v5.00 of the Agents can only run on a Stream Host running on Windows.
v5.00+
Pre v5.00
Current Version
Download the SQL Server Listener v5.53 (Last Updated: 11 Aug 2025)
Download the SQL Server Context Provider v5.53 (Last Updated: 11 Aug 2025)
Download the SQL Server Reader v1.00 (Last Updated: 16 Oct 2025)
Download the SQL Server Action Agent v5.53 (Last Updated: 11 Aug 2025)
Please contact XMPro if you're looking for an older Agent version.
Listener Release Notes
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 4.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
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.10
22 Aug 2019
Added option to select columns to be returned.
3.06
04 Mar 2019
Updated help URL.
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 Jun 2018
Validation bug fixed
3.01
21 May 2018
Validation added.
1.00
12 Apr 2018
Initial Release.
Context Provider Release Notes
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 4.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.07
09 Jun 2023
Added error handling for an invalid SQL query.
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.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 select columns to be returned, limit the number of rows, and sort the results.
3.08
04 Mar 2019
Updated help URL.
3.07
13 Aug 2018
Added error endpoint.
3.06
07 Aug 2018
Removed validation on Database to cater for SQL logins that don't have access to query master database.
3.05
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.04
27 Jun 2018
Validation bug fixed
3.01
21 May 2018
Validation added.
1.00
12 Apr 2018
Initial Release.
Reader (Action Agent) Release Notes
1.00
16 Oct 2025
Initial Release.
Action Agent Release Notes
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 4.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.23
06 Sep 2022
Repackaged to include the Agent's Category.
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 procedure.
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.1
04 Jun 2020
Added stored procedure 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 procedure functionality (this version doesn't have system variables).
3.08
14 Aug 2018
Added Checkbox in config settings to allow firing database triggers on insert (if defined).
3.07
13 Aug 2018
Added error endpoint.
3.06
07 Aug 2018
Removed validation on Database to cater for SQL logins that don't have access to query master database.
3.05
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.04
27 Jun 2018
Validation bug fixed.
3.03
22 Jun 2018
Batch Writing added.
3.02
21 May 2018
Validation added.
3.01
15 Apr 2018
Resolved the issue for the cases where the Database Table does not contain any record.
1.00
16 Mar 2018
Initial Release.
Last updated
Was this helpful?