ExtractFilesFromArchiveAction Class Reference

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

Inherits ArchiveAction.

Properties
FileFilter	FileFilter [get, set]
	Specifies the filter properties to use to filter files. More...
FileTarget	ArchiveFile [get, set]
	Specifies the archive file to read, extract, and iterate. For information about how to specify a folder in different file systems, see FileTarget. More...
FolderTarget	DestinationFolder [get, set]
	Specifies the destination folder. For information about how to specify a folder in different file systems, see FolderTarget. More...
OverwriteFileOperation	OverwriteFileOperation [get, set]
	Specifies the action to take when files of the same name already exist in the folder, as follows: More...
EncryptedString	Password [get, set]
	Specifies the password of the archive. 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

Extracts one or more files from an archive to a specified folder.

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

Actions:
- ExtractFilesFromArchiveAction:
    ArchiveFile: lib://backup
    DestinationFolder: C:\DestinationFolder
    OverwriteFileOperation: Failed
    Password: 1234
    Name: Extract Files from Archive
    # And more common action properties
    ...

Property Documentation

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

Specifies the archive file to read, extract, and iterate.
For information about how to specify a folder in different file systems, see FileTarget.

DestinationFolder

FolderTarget DestinationFolder

getset

Specifies the destination folder.
For information about how to specify a folder in different file systems, see FolderTarget.

OverwriteFileOperation

OverwriteFileOperation OverwriteFileOperation

getset

Specifies the action to take when files of the same name already exist in the folder, as follows:

• Replace: Specifies that the new content replaces the existing content. This is the default value.
• Serialize: Specifies that the new content is saved to a file that uses a serialized number that has the "filename(%d).ext" format.
• Timestamp: Specifies that the new content is saved to a file that uses a timestamp that has the "filename(yyyy-MM-ddTHH.mm.ss.fff).ext" format.
• Failed: Specifies that the new content is not saved.

Password

EncryptedString Password

getset

Specifies the password of the archive.

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:

• ExtractFilesFromArchiveAction.Properties.cs