SQL Server Listener

Description

The SQL Server Listener monitor and read new records from a SQL database.

Configuration

To add the SQL Server Listener to a stream, follow the steps below:

  1. Ensure you have a use case open in the stream designer, this can be a new use case or an existing use case
  2. From the toolbox on the left expand the Listener option and scroll down until you can see “SQL Server Listener”
    • You can also use the search in the header to find the stream object quickly
  3. Click and drag the SQL Server Listener from the toolbox onto the canvas
  4. Rename the Listener by clicking into the text button on the action bar
  5. Save the Stream by clicking the save button in the action bar
  6. Hover over the icon for the stream object until it turns orange and then double click to open the configuration page
    • You can optionally use the configure option on the action bar once you have selected the specific stream object and then clicking this option
  7. Configuration options
    • The drop-down allows you to associate this stream object with a specific collection. The default option is derived from the default specified against the specific use case and is generated left as the same option. If you do need to change it to another collection make the change by selecting the new collection in the drop-down.
    • Enter a value for the Polling Interval (the interval at which new records are accessed/checked for, in seconds)
  8. Enter Server Details
    • Enter the Server Instance
    • Enter the User Name
    • Tick “Use SQL Server Authentication” if you would like to use SQL server authentication. Enter the Password
  9. Enter Database Settings
    • Select Database from drop-down list
    • Select Table Name from drop-down list
    • Select Columns To Return from drop-down list if you would like only certain columns to return. If no columns specify, all columns will be returned
  10. Enter Timestamp Details
    • Select Column from drop-down list
  11. Click Apply on the action bar, and then save the stream using the save button.
Limitations

None at this time.

Release Notes
Version: 3.1
Released: 22-Aug-2019
Release Notes: Added option to select columns to be returned
Version Released Release Notes
3.06 04-March-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 the Database drop-down to allow custom values so that user can specify the database name manually, which is needed when login doesn’t have permission to query the master database; modified the error handling accordingly.
3.02 27-June-2018 Validation added

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X