AddFilesToArchiveAction Class Reference

Adds one or more files from a folder to an archive. More...

Inherits ArchiveAction.

Properties
FolderTarget	SourceFolder [get, set]
	Defines a FolderTarget object to specify the folder to read files from. More...
bool	IncludeChildFolders [get, set]
	Includes subfolders when the folder is iterated. The default value is false. More...
FileFilter	FileFilter [get, set]
	Specifies the filter properties to use to filter files. More...
FileTarget	ArchiveFile [get, set]
	Defines a FileTarget object to specify the destination archive file. More...
ArchiveUpdateMode	UpdateMode [get, set]
	Specifies the update mode, as follows: More...
ArchiveCompressionLevel	CompressionLevel [get, set]
	Specifies the compression level to apply to the archive, as follows: More...
EncryptedString	Password [get, set]
	Specifies the password for the archive. More...
EncryptionMethod	EncryptionMethod [get, set]
	Specifies the encryption method. This setting is optional. The default value is ZipCrypto. 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

Adds one or more files from a folder to an archive.

For common action properties, see IntegrationAction.
Example:

Actions:
- AddFilesToArchiveAction:
    SourceFolder: C:\Source
    IncludeChildFolders: true
    FileFilter:
      FilePattern: '*.txt'
      MaximumFileSize: 65536
      FilesOlderThan: 3600000
    ArchiveFile: C:\ZipFolder\temp.zip
    UpdateMode: UpdateAndAdd
    CompressionLevel: Fastest
    Password: 1234
    EncryptionMethod: AES256
    Name: Add Files to Archive
    # And more common action properties  
    ...

Property Documentation

SourceFolder

FolderTarget SourceFolder

getset

Defines a FolderTarget object to specify the folder to read files from.

IncludeChildFolders

bool IncludeChildFolders

getset

Includes subfolders when the folder is iterated. The default value is false.

FileFilter

FileFilter FileFilter

getset

Specifies the filter properties to use to filter files.

Example:

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

ArchiveFile

FileTarget ArchiveFile

getset

Defines a FileTarget object to specify the destination archive file.

UpdateMode

ArchiveUpdateMode UpdateMode

getset

Specifies the update mode, as follows:

• AddAndReplace: Adds all specified files to the archive and replaces files of the same name that already exist in the archive with the new files. This is the default value.
• UpdateAndAdd: Updates existing files in the archive with their newer versions and adds new files to the archive.
• FreshenExisting: Updates existing files in the archive with their newer versions when these existing files are older than the selected source location files.
• Synchronize: Replaces the specified files only if the added files are newer, adds files that are not already in the archive, and deletes from the archive those files that no longer exist in the source location.

CompressionLevel

ArchiveCompressionLevel CompressionLevel

getset

Specifies the compression level to apply to the archive, as follows:

• Normal (default)
• Store
• Fastest
• Fast
• Maximum
• Ultra

Password

EncryptedString Password

getset

Specifies the password for the archive.

EncryptionMethod

EncryptionMethod EncryptionMethod

getset

Specifies the encryption method. This setting is optional. The default value is ZipCrypto.

• ZipCrypto (default)
• AES256

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:

• AddFilesToArchiveAction.Properties.cs