CaseActions Class Reference

Defines the Case action group and runs the group of actions when the case condition is met.
For more information, see ActionGroup and SelectCaseAction. More...

Inherits ActionGroup.

Properties
CaseActionCondition	Condition [get, set]
	Specifies the case condition to use to run actions. The parent SelectCaseAction evaluates the condition to determine whether the group of actions should run. If CaseCondition is not specified, the default case is used, which means that the group of actions runs only when all of the other conditions are not met. Example of a case condition that equals a certain value: 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

Defines the Case action group and runs the group of actions when the case condition is met.
For more information, see ActionGroup and SelectCaseAction.

For common action properties, see IntegrationAction.
Example:

Actions:
- SelectCaseAction:
    ConditionVariableName: CurrentTimeHour
    Name: Select Case(%CurrentTimeHour%)
    Cases:
    - Case:
        Condition.InBetween:
          StartRange: 1
          EndRange: 6
        Name: %CurrentTimeHour% is between 1 and 6
        Actions:
        - WriteMessageToLogAction:
          ...
        - SendEmailAction:
          ...
    - Case:
        Condition.Equals:
          Value: 12
        Name: %CurrentTimeHour% equals 12
        Actions:
        ...
    - Case:
        Condition.IsAnyOf:
          Values: [13, 15, 17]
        Name: %CurrentTimeHour% in the set of (13, 15, 17)
    - Case:
       # Do not specify case condition for the default case.
        Name: Default case
        Actions:
        - StopAction:
        ...
    # And more common action properties
    ...      

Property Documentation

Condition

CaseActionCondition Condition

getset

Specifies the case condition to use to run actions. The parent SelectCaseAction evaluates the condition to determine whether the group of actions should run.
If CaseCondition is not specified, the default case is used, which means that the group of actions runs only when all of the other conditions are not met.
Example of a case condition that equals a certain value:

Condition.Equals:
  Value: 12

Example of a case condition that is between two values:

Condition.IsBetween:
  StartRange: A
  EndRange: Z     

Example of a case condition that is one of a set of values:

Condition.IsAnyOf:
  Values: 
  - Apple
  - Banana
  - Cherry

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:

• CaseActions.Properties.cs