WorkflowTransitionAction Class Reference

Move the librarian file from one state to another in its workflow by the specified transition. More...

Inherits IntegrationAction.

Properties
FileTarget	SourceFile [get, set]
	Specifies the source file path in Librarian file system. For information about how to specify a file in Librarian file systems, see FileTarget. More...
string	Transition [get, set]
	Specifies the transition. More...
string	Comment [get, set]
	Comment of the transition action. The default value is "". More...
bool	IgnoreErrorsIfNoTransition [get, set]
	Ignore the errors if there is no specified transition. The default value is false. 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

Move the librarian file from one state to another in its workflow by the specified transition.

Example:

Actions:  
- WorkflowTransitionAction:
     SourceFile: lib://sample.btw
     Transition: Approve to state
     Comment: Transit to specified state
     IgnoreErrorsIfNoTransition: false

Property Documentation

SourceFile

FileTarget SourceFile

getset

Specifies the source file path in Librarian file system. For information about how to specify a file in Librarian file systems, see FileTarget.

Transition

string Transition

getset

Specifies the transition.

Comment

string Comment

getset

Comment of the transition action. The default value is "".

IgnoreErrorsIfNoTransition

bool IgnoreErrorsIfNoTransition

getset

Ignore the errors if there is no specified transition. The default value is false.

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:

• WorkflowTransitionAction.Properties.cs