Actions YAML Reference
Properties | List of all members
RunAsUserActions Class Reference

Runs a group of actions by using the credentials that are specified. More...

Inherits ActionGroup.

Properties

ActionCredentials Credentials [get, set]
 Specifies the user credentials that the action group will run under. These credentials have the following properties: 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< IntegrationActionActions [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 a group of actions by using the credentials that are specified.

Example:

- RunAsUserActions:
Domain: MyCompany
UserName: user001
Password: mypassword
- ShellCommandAction:
...
- CopyFolderAction:
...
Name: RunActionsAsUser001
# And more common action properties
...
List< IntegrationAction > Actions
Lists the actions or integrations that are defined for the document. Example:
Definition: ActionGroup.Properties.cs:145
ActionCredentials Credentials
Specifies the user credentials that the action group will run under. These credentials have the follo...
Definition: RunAsUserActions.Properties.cs:66
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87

Property Documentation

◆ Credentials

ActionCredentials Credentials
getset

Specifies the user credentials that the action group will run under. These credentials have the following properties:

  • Domain: Specifies the domain name. This property can be ignored if the user is on the local machine.
  • UserName: Specifies the user name. This value must not be empty.
  • Password: Specifies the password in plain text.

If Credentials are not specified, the action group runs as a typical ActionGroup.


Example:

Domain: MyCompany
UserName: user001
Password: mypassword

◆ 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:

- 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: