WaitForFileAction Class Reference

Waits for a file to appear in a specified folder before running subsequent actions. More...

Inherits IntegrationAction, and IFileFolderOptions.

Public Member Functions
void	InitializeProperties_WaitForFileAction ()

Properties
DetectionMethod	ScanMethod [get, set]
	Specifies the method that the action uses to monitor the scan folder for the arrival of the specified file, as follows: More...
int	PollingInterval [get, set]
	Specifies the polling interval, in milliseconds. More...
FolderTarget	ScanFolder [get, set]
	Specifies the folder to scan. For more examples, see FolderTarget. More...
string	FilePattern [get, set]
	Specifies the filter that the action uses to identify the file on which you want the action to be run. More...
FilterType	PatternType [get, set]
	Specifies the filter type to use, as follows: More...
bool	ScanChildFolders [get, set]
	Specifies whether to monitor all the subfolders of the ScanFolder. The default value is false. More...
List< SortOrderItem >	MultipleFilesSortOrder [get, set]
	Defines the order in which the action processes files in the specified folder when more than one file matches the FilePattern. The following Field options are available: More...
int	MinimumFileSize [get, set]
	Specifies the minimum file size that the file must be to be accepted as the source file. More...
int	MaximumFileSize [get, set]
	Specifies the file size that the file cannot exceed to be accepted as the source file. This property is ignored if it is set to -1. More...
long	FileIdleTime [get, set]
	Specifies that a file is accepted as the source file if the file's age (based on the value of LastModifiedTime) is older than the value of FileIdleTime, in milliseconds. This property is ignored if it is set to -1. More...
string	DetectFileState [get, set]
	Triggers an event if the state of the file was changed to the specified file state. More...
bool	DetectFileChanged [get, set]
	Triggers an event if the file is changed. More...
bool	DetectFileCreated [get, set]
	Triggers an event if there is a valid file or a new file is created. The default value is true. More...
string	OutputVariableName [get, set]
	Specifies the name of the variable to place the file name into as a string. The default value is "FileName". 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

Waits for a file to appear in a specified folder before running subsequent actions.

For common action properties, see IntegrationAction. Also see similar settings in FileIntegration.
Example:

Actions:  
- WaitForFileAction:
    ScanMethod: Notification
    ScanFolder: C:\Scan
    FilePattern: '*.dat'
    ScanChildFolders: true
    MultipleFilesSortOrder:
    - Field: Name
    - Field: LastModifiedTime
      Direction: Descending
    Name: Wait for File
    # And more common action properties
    ...

Property Documentation

ScanMethod

DetectionMethod ScanMethod

getset

Specifies the method that the action uses to monitor the scan folder for the arrival of the specified file, as follows:

• Notification
• Polling
• NotificationPolling (default)

PollingInterval

int PollingInterval

getset

Specifies the polling interval, in milliseconds.

ScanFolder

FolderTarget ScanFolder

getset

Specifies the folder to scan.
For more examples, see FolderTarget.

FilePattern

string FilePattern

getset

Specifies the filter that the action uses to identify the file on which you want the action to be run.

PatternType

FilterType PatternType

getset

Specifies the filter type to use, as follows:

• Wildcard (default)
• RegularExpression

ScanChildFolders

bool ScanChildFolders

getset

Specifies whether to monitor all the subfolders of the ScanFolder. The default value is false.

MultipleFilesSortOrder

List<SortOrderItem> MultipleFilesSortOrder

getset

Defines the order in which the action processes files in the specified folder when more than one file matches the FilePattern.
The following Field options are available:

• CreationTime (default)
• LastModifiedTime
• Name
• Size

The following Direction options are available:

• Ascending (default)
• Descending

Example:

MultipleFilesSortOrder:
- Field: Name             # First, sort by Name, Ascending
- Field: LastModifiedTime # Then, sort by LastModifiedTime, Descending
  Direction: Descending     

MinimumFileSize

int MinimumFileSize

getset

Specifies the minimum file size that the file must be to be accepted as the source file.

MaximumFileSize

int MaximumFileSize

getset

Specifies the file size that the file cannot exceed to be accepted as the source file. This property is ignored if it is set to -1.

FileIdleTime

long FileIdleTime

getset

Specifies that a file is accepted as the source file if the file's age (based on the value of LastModifiedTime) is older than the value of FileIdleTime, in milliseconds. This property is ignored if it is set to -1.

DetectFileState

string DetectFileState

getset

Triggers an event if the state of the file was changed to the specified file state.

DetectFileChanged

bool DetectFileChanged

getset

Triggers an event if the file is changed.

DetectFileCreated

bool DetectFileCreated

getset

Triggers an event if there is a valid file or a new file is created. The default value is true.

OutputVariableName

string OutputVariableName

getset

Specifies the name of the variable to place the file name into as a string. The default value is "FileName".

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:

• WaitForFileAction.Properties.cs