WhileLoopActions Class Reference

Continues to run the actions in the group as long as the condition is satisfied. More...

Inherits ActionGroup.

Properties
WhileLoopActionGroupRepeatType	RepeatType [get, set]
	Specifies how long the action runs, as follows: More...
ActionConditionExpression	RepeatConditionExpression [get, set]
	Specifies the repeat conditional expression if the value of RepeatType is WhileVariableMeetsCondition or WhileExpressionMeetsCondition. Example: More...
bool	CheckConditionBeforeRunActions [get, set]
	Specifies whether the condition is checked before or after the group of actions is run. The default value is false. 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...
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...

Detailed Description

Continues to run the actions in the group as long as the condition is satisfied.

For more properties, see ActionGroup and IntegrationAction.
Example:

Actions:
- WhileLoopActions:
    RepeatType: WhenVariableMeetsCondition
    RepeatConditionExpression:
      Expression: Not IsNullOrEmpty([%FileName%])   
    CheckConditionBeforeRunActions: true
    Name: While Loop
    Actions:
    - PrintBTWActions:
      ...
    - SendEmailAction:
      ...
    # And more common action properties
    ... 

Property Documentation

RepeatType

WhileLoopActionGroupRepeatType RepeatType

getset

Specifies how long the action runs, as follows:

• WhileVariableMeetsCondition (while the variable meets the condition)
• WhileExpressionMeetsCondition (while the expression meets the condition)
• Forever (default)

RepeatConditionExpression

ActionConditionExpression RepeatConditionExpression

getset

Specifies the repeat conditional expression if the value of RepeatType is WhileVariableMeetsCondition or WhileExpressionMeetsCondition.
Example:

RepeatConditionExpression:
  Expression: Not IsNullOrEmpty([%EventData%])

Example:

RepeatConditionExpression:
  Expression: Not IsNullOrEmpty([%EventData%]) And[% StatusCode %] = 200.0
  VariableDataTypeString: '{"EventData":"Text","StatusCode":"Decimal"}'

CheckConditionBeforeRunActions

bool CheckConditionBeforeRunActions

getset

Specifies whether the condition is checked before or after the group of actions is run. The default value is false.

ExecutionMethod

ActionGroupRunMethod ExecutionMethod

getsetinherited

Specifies how the group of actions runs, as follows:

• Sequential (default)
• Parallel

ExecutionTimes

int ExecutionTimes

getsetinherited

Specifies the number of times to run the action group in a loop. The default value is 1.

Actions

List<IntegrationAction> Actions

getsetinherited

Lists the actions or integrations that are defined for the document.
Example:

Actions:
- PrintBTWAction:
  ...
- WriteFileAction:
  ...
- WhileLoopActions:
  ...

Name

string Name

getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries

int FailureRetries

getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval

int RetryInterval

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.

---

The documentation for this class was generated from the following file:

• WhileLoopActions.Properties.cs