Runs actions for each record in a database query.
More...
Inherits ActionGroup.
|
string | FieldVariableNamePrefix [get, set] |
| Specifies the prefix that is added to the field's variable name. The default value is "". More...
|
|
string | FieldVariableNamePostfix [get, set] |
| Specifies the suffix that is added to the field's variable name. The default value is "". More...
|
|
DataTarget? | RecordSetSource [get, set] |
| Specifies the source of the record set. More...
|
|
ActionGroupRunMethod | ExecutionMethod [get, set] |
| Specifies how the group of actions runs, as follows: More...
|
|
int | ExecutionTimes [get, set] |
| Specifies the number of times to run the action group in a loop. The default value is 1. More...
|
|
List< IntegrationAction > | Actions [get, set] |
| Lists the actions or integrations that are defined for the document.
Example: More...
|
|
|
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 actions for each record in a database query.
For common action properties, see ActionGroup and IntegrationAction.
Example:
- ForEachDatabaseRecordActions:
Name: For Each Database Record
- PrintBTWActions:
...
- SendEmailAction:
...
# And more common action properties
...
List< IntegrationAction > Actions
Lists the actions or integrations that are defined for the document. Example:
Definition: ActionGroup.Properties.cs:145
string FieldVariableNamePrefix
Specifies the prefix that is added to the field's variable name. The default value is "".
Definition: ForEachDatabaseRecordActions.Properties.cs:60
string FieldVariableNamePostfix
Specifies the suffix that is added to the field's variable name. The default value is "".
Definition: ForEachDatabaseRecordActions.Properties.cs:68
DataTarget? RecordSetSource
Specifies the source of the record set.
Definition: ForEachDatabaseRecordActions.Properties.cs:79
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87
◆ FieldVariableNamePrefix
string FieldVariableNamePrefix |
|
getset |
Specifies the prefix that is added to the field's variable name. The default value is "".
◆ FieldVariableNamePostfix
string FieldVariableNamePostfix |
|
getset |
Specifies the suffix that is added to the field's variable name. The default value is "".
◆ RecordSetSource
Specifies the source of the record set.
Example in which the event data of the parent integration is used as the record set source:
◆ ExecutionMethod
ActionGroupRunMethod ExecutionMethod |
|
getsetinherited |
Specifies how the group of actions runs, as follows:
- Sequential (default)
- Parallel
◆ ExecutionTimes
Specifies the number of times to run the action group in a loop. The default value is 1.
◆ Actions
Lists the actions or integrations that are defined for the document.
Example:
- PrintBTWAction:
...
- WriteFileAction:
...
- WhileLoopActions:
...
◆ Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
◆ Description
Specifies the description. The default value is "".
◆ RunType
Runs the action by using one of the following types:
◆ IgnoreErrors
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.
◆ FailureRetries
Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.
◆ RetryInterval
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.
The documentation for this class was generated from the following file:
- ForEachDatabaseRecordActions.Properties.cs