StopAction Class Reference

Stops all actions in the current execution. More...

Inherits IntegrationAction.

Properties
bool	ReportError [get, set]
	Specifies whether an error message is recorded and displayed in Administration Console. The default value is false. More...
string	ErrorMessage [get, set]
	Specifies the error message that is associated with the Stop action when the value of ReportError is true. 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

Stops all actions in the current execution.

For common action properties, see IntegrationAction.
Example:

Actions:
- StopAction:
    ReportError: true
    ErrorMessage: User stops the execution!
    # And more common action properties
    ... 

Property Documentation

ReportError

bool ReportError

getset

Specifies whether an error message is recorded and displayed in Administration Console. The default value is false.

ErrorMessage

string ErrorMessage

getset

Specifies the error message that is associated with the Stop action when the value of ReportError is true.

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:

• StopAction.Properties.cs