ForEachFileInFolderActions Class Reference

Runs a group of one or more actions for all files in a folder that match a specified filter. More...

Inherits ForEachActionGroup< T >.

Properties
FolderTarget	SourceFolder [get, set]
	Specifies the source folder. For examples, see FolderTarget. More...
FileFilter	FileFilter [get, set]
	Specifies the filter properties to use to filter files. More...
bool	IncludeChildFolders [get, set]
	Specifies whether to include subfolders when the folder is iterated. The default value is false. More...
bool	DeleteFileWhenDone [get, set]
	Specifies whether to delete the file when the actions are completed. The default value is true. More...
string	FilePropertyVariable [get, set]
	Specifies the name of the variable to save the file properties to. The default value is "File". 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

Runs a group of one or more actions for all files in a folder that match a specified filter.

For common action properties, see ActionGroup and IntegrationAction.
Example:

Actions:   
- ForEachFileInFolderActions:
    SourceFolder: C:\SourceFolder
    FileFilter:
      FilePattern: '*.txt'
    IncludeChildFolders: true
    Name: For Each File in Folder
    Actions:
    - PrintBTWActions:
      ...
    - SendEmailAction:
      ...
    # And more common action properties
    ...

Property Documentation

SourceFolder

FolderTarget SourceFolder

getset

Specifies the source folder. For examples, see FolderTarget.

FileFilter

FileFilter FileFilter

getset

Specifies the filter properties to use to filter files.

Example:

FileFilter:
  FilePattern: '*.txt'
  MaximumFileSize: 65536
  FilesOlderThan: 3600000

IncludeChildFolders

bool IncludeChildFolders

getset

Specifies whether to include subfolders when the folder is iterated. The default value is false.

DeleteFileWhenDone

bool DeleteFileWhenDone

getset

Specifies whether to delete the file when the actions are completed. The default value is true.

FilePropertyVariable

string FilePropertyVariable

getset

Specifies the name of the variable to save the file properties to. The default value is "File".

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:

• ForEachFileInFolderActions.Properties.cs