Comment on page

Configuration

This section explains each of the properties in the configuration blade. 
General
Property
Description
Collection
This associates this Agent to a specific Collection and defaults to that of the current Data Stream.
Visit Collections and Stream Hosts to understand more about Collections.
Server
Property
Description
Use Connection Variables
Tick to select saved variables; or enter the text manually for the authentication properties.
Server Instance
The address of the Azure SQL server instance.
User Name
The user name to use for authenticating the connection.
Password
The password to use for authenticating the connection.
Once all the Server properties are entered, the Agent will attempt to open a connection with the database server. If successful, then the Database property will be populated with a list of available databases to select.
Database
Property
Description
Database
The name of the database to connect to.
Once selected, the Table property will be populated with the list of available tables in the database.
Use Stored Procedure
Executes a Stored Procedure (already defined in the database) instead of writing to a table.
Return Result As
Choose whether the results should be appended to the input data or replace the input data as a new dataset.
Applies if Use Stored Prcedure is ticked. 
Stored Procedure
Displays a list of avialable Stored Procedures. Select the Stored Procedure that the action Agent should execute.
Applies if Use Stored Prcedure is ticked.
Create New Table
Creates a new table in the database before writing data to it.
Table Name
The name of the new table that should be created.
Applies if Create New Table is ticked.
Table
The name of the table to connect to.
Once selected, the Columns To Return property will be populated with the list of columns from the selected table.
Command
The operation the Agent should perform, either Insert or Update.
Fire Database Triggers on Insert (if defined)
Allows the database to execute any Insert Triggers that might be define in the database when the data is inserted into the table.
Command Timeout (secs)
A timespan to specify the timeout before a command is aborted.
Endpoints
Property
Description
Input
This endpoint is used to receive data from the parent Agent.
Output
Events received from the parent Agent are processed and the result events are made available to the Endpoint.
These events are the same as the input events when using the Insert or Update Command, but can differ if the Agent is configured to execute a Stored Procedure, in which case the output will match the payload of the Stored Procedure.
Error
If errors are encountered during the execution of this Agent they will be published on this endpoint.
If the events passed to the Action Agent require further processing in the Data Stream, and the Action Agent is configured to execute a Stored Procedure, split the Data Stream beforehand with a Broadcast Transformation.

Property	Description
Collection	This associates this Agent to a specific Collection and defaults to that of the current Data Stream.

Property	Description
Use Connection Variables	Tick to select saved variables; or enter the text manually for the authentication properties.
Server Instance	The address of the Azure SQL server instance.
User Name	The user name to use for authenticating the connection.
Password	The password to use for authenticating the connection.

Property	Description
Database	The name of the database to connect to. Once selected, the Table property will be populated with the list of available tables in the database.
Use Stored Procedure	Executes a Stored Procedure (already defined in the database) instead of writing to a table.
Return Result As	Choose whether the results should be appended to the input data or replace the input data as a new dataset. Applies if Use Stored Prcedure is ticked.
Stored Procedure	Displays a list of avialable Stored Procedures. Select the Stored Procedure that the action Agent should execute. Applies if Use Stored Prcedure is ticked.
Create New Table	Creates a new table in the database before writing data to it.
Table Name	The name of the new table that should be created. Applies if Create New Table is ticked.
Table	The name of the table to connect to. Once selected, the Columns To Return property will be populated with the list of columns from the selected table.
Command	The operation the Agent should perform, either Insert or Update.
Fire Database Triggers on Insert (if defined)	Allows the database to execute any Insert Triggers that might be define in the database when the data is inserted into the table.
Command Timeout (secs)	A timespan to specify the timeout before a command is aborted.

Property	Description
Input	This endpoint is used to receive data from the parent Agent.
Output	Events received from the parent Agent are processed and the result events are made available to the Endpoint. These events are the same as the input events when using the Insert or Update Command, but can differ if the Agent is configured to execute a Stored Procedure, in which case the output will match the payload of the Stored Procedure.
Error	If errors are encountered during the execution of this Agent they will be published on this endpoint.

Action Agent - Previous

Example

Next - Action Agent

Release Notes

Last modified 1yr ago