Azure SQL Action Agent

Description

Writes data to an Azure SQL database.

Configuration

To add the Azure SQL Action Agent 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 Action Agents option and scroll down until you can see “Azure SQL”
    • You can also use the search in the header to find the agent quickly
  3. Click and drag the Azure SQL Action Agent from the toolbox onto the canvas
  4. Rename the action agent by clicking into the text area to the right of the icon
  5. Save the Stream by clicking the save button in the action bar
  6. Hover over the icon for the action agent 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 agent and then clicking this option
  7. Configuration options
    • The Collection drop-down allows you to associate this agent with a specific collection. The selected option would be, by default, the same as the collection that was selected for the use case. If you do need to change it to another collection, select a different collection from the drop-down.
  8. Server options
    • Specify Server Instance
    • Add User Name
    • Add Password
  9. Database
    • Select the database you would like to write to
    • If you would like to create a new table, select the “Create New Table” checkbox and specify the name of the new table in the Table Name textbox
    • To use an existing table from the Table drop-down.
  10. If you need to fire database triggers on Insert, select the “Fire Database Triggers on Insert (if defined)” checkbox.
  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.07
Released: 4-March-2019
Release Notes: Updated help URL.
Version Released Release Notes
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 OnError 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 drop down 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.0 06-June-2018 Initial Release.

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

X