ConditionActions Class Reference

Runs either actions for true or actions for false based on the result of the condition. More...

Inherits ActionGroup, and IYamlConvertibleExt.

Properties
ActionConditionExpression	ConditionExpression [get, set]
	Specifies a conditional expression in the following properties when the value of ConditionType is BasedOnVariable or BasedOnExpression. Valid only for Action and ActionGroup. More...
ConditionType	ConditionType [get, set]
	Specifies the condition type, as follows: More...
ActionArrayWrapper	RunWhenTrueActions [get, set]
	Lists the actions that run when the condition is true. Example: More...
ActionArrayWrapper	RunWhenFalseActions [get, set]
	Lists the actions that run when the condition is false. Example: 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

Runs either actions for true or actions for false based on the result of the condition.

For common action properties, see ActionGroup and IntegrationAction. Example:

Actions:
- ConditionActions:
    Name: MyCondition
    ConditionType: BasedOnVariable
    ConditionExpression:
      Name: ConditionActions
      Expression: '[%Variable1%] = 1.0'
      VariableDataTypes: '{"Variable1":"Decimal"}'
    RunWhenTrueActions:
    - PrintBTWAction:
      ...
    - WriteMessageToLogAction:
      ...
    RunWhenFalseActions:
    - WriteMessageToLogAction:
      ...
    - SendEmailAction:
      ...
    # And more common action properties
    ...      

Property Documentation

ConditionExpression

ActionConditionExpression ConditionExpression

getset

Specifies a conditional expression in the following properties when the value of ConditionType is BasedOnVariable or BasedOnExpression. Valid only for Action and ActionGroup.

• Expression: Specifies the expression to evaluate. For information about how to compile an expression, refer to Criteria Language Syntax.
• VariableDataType: Specifies a formatted string, such as {"VariableName":"Text|Decimal",...}, to specify data type information for the variables that appear in the first operands of the condition clauses in the expression.

For more information, see ActionConditionExpression.
Example in which the value of ConditionType is BasedOnVariable:

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

Example in which the value of ConditionType is BasedOnExpression:

ConditionExpression:
  Expression: Not IsNullOrEmpty([%EventData%]) And [% CurrentTimeHour %] >= 12.0
  VariableDataTypes: '{"EventData":"Text","CurrentTimeHour":"Decimal"}'

ConditionType

ConditionType ConditionType

getset

Specifies the condition type, as follows:

• BasedOnVariable (default)
• BasedOnExpression
• AlwaysTrue
• AlwaysFalse

RunWhenTrueActions

ActionArrayWrapper RunWhenTrueActions

getset

Lists the actions that run when the condition is true. Example:

RunWhenTrueActions:
- PrintBTWAction:
  ...
- WriteFileAction:
  ...
- WhileLoopActions:
  ...

RunWhenFalseActions

ActionArrayWrapper RunWhenFalseActions

getset

Lists the actions that run when the condition is false. Example:

RunWhenFalseActions:
- WriteMessageToLogAction:
  ...
- SendEmailAction:
  ...
- StopAction:
  ...

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:

• ConditionActions.Properties.cs