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 Writer (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

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.

Current Version

  • Download the SQL Server Listener v5.50

  • Download the SQL Server Context Provider v5.50

  • Download the SQL Server Action Agent v5.50

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

Listener Release Notes

v5.5, 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

Older

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

  • This is a breaking change - note the updated pre-requisites

v4.03, 06 Sep 2022

  • Repackaged to include the Agent's Category

v4.02, 05 Aug 2020

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

v4.01, 28 Jul 2020

  • XMP Error for Password Variable box fixed

v4.0, 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

v3.1, 22 Aug 2019

  • Added option to select columns to be returned

v3.06, 04 Mar 2019

  • Updated help URL

v3.05, 13 Aug 2018

  • Added error endpoint

v3.04, 07 Aug 2018

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

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

v3.02, 27 Jun 2018

  • Validation bug fixed

v3.01, 21 May 2018

  • Validation Added

v1.0, 12 Apr 2018

  • Initial Release

Context Provider Release Notes

v5.5, 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

Older

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

  • This is a breaking change - note the updated pre-requisites

v4.07, 09 Jun 2023

  • Added error handling for an invalid SQL query

v4.06, 06 Sep 2022

  • Repackaged to include the Agent's Category

v4.05, 19 Nov 2021

  • Fixed validation error when using SQL query option

v4.04, 24 Aug 2021

  • Added option to specify SQL Query

v4.03, 06 Oct 2020

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

v4.02, 05 Aug 2020

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

v4.01, 28 July 2020

  • XMP Error for Password Variable box fixed

v4.0, 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

v3.12, 22 Oct 2019

  • Incorporate changes to Filter the Agent

v3.11, 09 Sep 2019

  • Added filter option

v3.1, 22 Aug 2019

  • Added option to select columns, limit the number of rows, and sort the results

v3.08, 04 Mar 2019

  • Updated help URL

v3.07, 13 Aug 2018

  • Added Error endpoint

v3.06, 07 Aug 2018

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

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

v3.04, 27 Jun 2018

  • Validation bug fixed

v3.01, 21 May 2018

  • Validation added

Action Agent Release Notes

v5.5, 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

v5.30, 07 Jun 2024

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

v5.20, 16 Apr 2024

  • Added Dynamic SQL query support

Older

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

  • This is a breaking change - note the updated pre-requisites

v4.23, 06 Sep 2022

  • Repackaged to include the Agent's Category

v4.22, 02 Feb 2021

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

v4.21, 04 Sep 2020

  • Fix for handling null values in the payload

v4.2, 03 Sep 2020

  • Outputting original payload and added return type option when using stored procedure

v4.12, 05 Aug 2020

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

v4.11, 28 July 2020

  • XMP Error for Password Variable box fixed

v4.1, 04 Jun 2020

  • Added stored procedure functionality

v4.0, 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

v3.1, 04 Jun 2020

  • Added stored procedure functionality (this version doesn't have system variables)

v3.08, 14 Aug 2018

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

v3.07, 13 Aug 2018

  • Added OnError endpoint

v3.06, 07 Aug 2018

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

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

v3.04, 27 June 2018

  • Validation bug fixed

v3.03, 22 Jun 2018

  • Batch Writing added

v3.02, 21 May 2018

  • Validation Added

v3.01, 15 Apr 2018

  • Resolved the issue for the cases where the Database Table does not contain any record

v1.0, 16 March 2018

  • Initial Release

Last updated