WriteFileAction Class Reference

Writes content to a file. More...

Inherits IntegrationAction.

Properties
DataTarget	Source [get, set]
	Specifies the source of the content to be written. Example in which the source is a variable: More...
ActionTextEncoding	TextEncoding [get, set]
	Specifies the text encoding scheme to use when saving the file. The default value is UnicodeUTF8. More...
FileActionSaveMethod	SaveMode [get, set]
	Specifies the action to take when a destination file that has the same name already exists, as follows: More...
FileTarget	File [get, set]
	Specifies the path of the destination file to use to save the file to. More...
int	LockedFileTimeout [get, set]
	Specifies the amount of time, in milliseconds, to try to open a file that is found to be initially locked by another application. The default value is 30000. More...
string	PathVariableName [get, set]
	Specifies the name of the variable to save the destination file path to. 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

Writes content to a file.

For common action properties, see IntegrationAction.
Example:

Actions:
- WriteFileAction:
    Source: 'Today is %CurrentDate%. Time now: %CurrentTime%'
    TextEncoding: USWesternEurope_1252
    File: dropbox://MyDropbox/Folder/FileName.txt
    PathVariableName: SavedFileName
    Name: Write File
    # And more common action properties
    ...

Property Documentation

Source

DataTarget Source

getset

Specifies the source of the content to be written.
Example in which the source is a variable:

Source: '%EventData%'

Example in which the source is a template with variables:

Source: 'Today is %CurrentDate%. Time now: %CurrentTime%'

Example in which the source is a file from the computer or network or from Librarian:

Source: 
  File: lib://MySecretFolder/data.txt

Example in which the source is a cloud file:

Source: 
  File: dropbox://MyDropbox/Folder/FileName.txt

TextEncoding

ActionTextEncoding TextEncoding

getset

Specifies the text encoding scheme to use when saving the file. The default value is UnicodeUTF8.

SaveMode

FileActionSaveMethod SaveMode

getset

Specifies the action to take when a destination file that has the same name already exists, as follows:

• SerializedSuffix: Specifies that the file name is made unique by appending a serial number. This is the default setting.
  
• Timestamp: Specifies that the file name is made unique by appending a timestamp.
• Append: Specifies that the new content is appended to the existing file.
• Overwrite: Specifies that the existing file is replaced with the new file.
• Failed: Specifies that the new content is not saved and an error message is displayed.

File

FileTarget File

getset

Specifies the path of the destination file to use to save the file to.

LockedFileTimeout

int LockedFileTimeout

getset

Specifies the amount of time, in milliseconds, to try to open a file that is found to be initially locked by another application. The default value is 30000.

PathVariableName

string PathVariableName

getset

Specifies the name of the variable to save the destination file path to.

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:

• WriteFileAction.Properties.cs