SelectCaseAction Class Reference

Evaluates which Case subactions to run, according to their specified conditions.
More...

Inherits ActionGroup.

Properties
string	ConditionVariableName [get, set]
	Specifies the name of the variable that is evaluated to determine the case conditions and the Case subactions to run. The action will not run if this property is null or empty. 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

Evaluates which Case subactions to run, according to their specified conditions.

For common action properties, see IntegrationAction. Also see CaseActions for information about how to specify a Case action group.
Example:

Actions:
- SelectCaseAction:
    ConditionVariableName: CurrentTimeHour
    Name: Select Case(%CurrentTimeHour%)
    Cases:
    - Case:
        Condition.IsBetween:
          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

ConditionVariableName

string ConditionVariableName

getset

Specifies the name of the variable that is evaluated to determine the case conditions and the Case subactions to run. The action will not run if this property is null or empty.

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:

• SelectCaseAction.Properties.cs