Actions YAML Reference
|
Runs an SQL script. More...
Inherits IntegrationAction.
Inherited by DeleteDatabaseRecordAction, InsertDatabaseRecordAction, and UpdateDatabaseRecordsAction.
Properties | |
DataTarget | ConnectionSetup [get, set] |
Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget. More... | |
DataTarget | Command [get, set] |
Specifies the SQL command source to run. This property is ignored if the command tries to modify a database that does not support modification by using SQL. More... | |
string | RecordSetVariableName [get, set] |
Specifies the variable to save the output record set to, if a record set is returned. The default value is EventData. More... | |
CommonActionProperties | |
Describes the common action properties for Actions and ActionGroups. | |
string | Name [get, set] |
Specifies the name. This property cannot be empty and must be unique in the YAML script. More... | |
string | Description [get, set] |
Specifies the description. The default value is "". More... | |
ActionRunType | RunType [get, set] |
Runs the action by using one of the following types: More... | |
bool | IgnoreErrors [get, set] |
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More... | |
int | FailureRetries [get, set] |
Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More... | |
int | RetryInterval [get, set] |
Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More... | |
Runs an SQL script.
For common action properties, see IntegrationAction.
Example:
Example in which the same connection setup from the parent DatabaseIntegration and the Command from a local file are used:
|
getset |
Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget.
Example in which the database connection setup from the XML generated by the Database Setup wizard is used.
Example in which the database connection setup from a file in the temporary storage:
Example in which the database connection setup from a local file or a Librarian file is used:
Example in which the database connection setup from a could file is used:
|
getset |
Specifies the SQL command source to run. This property is ignored if the command tries to modify a database that does not support modification by using SQL.
Example:
Example in which an SQL command from a file in the temporary storage:
Example in which an SQL command from a local file or a Librarian file is run:
Example in which an SQL command from a cloud file is run:
|
getset |
Specifies the variable to save the output record set to, if a record set is returned. The default value is EventData.
|
getsetinherited |
Specifies the name. This property cannot be empty and must be unique in the YAML script.
|
getsetinherited |
Specifies the description. The default value is "".
|
getsetinherited |
Runs the action by using one of the following types:
|
getsetinherited |
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.
|
getsetinherited |
Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.
|
getsetinherited |
Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.