MoveFolderAction Class Reference

Moves a folder from one location to another. More...

Inherits CopyFolderAction.

Inherited by RenameFolderAction.

Properties
FolderTarget	DestinationFolder [get, set]
	Specifies the destination to which the folder is copied. For information about how to specify a folder in different file systems, see FolderTarget. More...
FolderTarget	SourceFolder [get, set]
	Specifies the source folder from which the files are copied. For information about how to specify a folder in different file systems, see FolderTarget. More...
string	FolderNameVariable [get, set]
	Saves the folder name to a variable. More...
OverwriteFileOperation	OverwriteFolderOperation [get, set]
	Specifies the action to take when a file that has the same name already exists in the folder, as follows: 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

Moves a folder from one location to another.

For common action properties, see IntegrationAction. Also see CopyFolderAction for similar settings.
Example of moving a folder from Librarian to a local folder:

Actions:
- MoveFolderAction:
    DestinationFolder: C:\Destination
    SourceFolder: lib://Source
    FolderNameVariable: NewFolderPath
    OverwriteFolderOperation: Replace
    Name: Move Folder
    # And more common action properties
    ...

Property Documentation

DestinationFolder

FolderTarget DestinationFolder

getsetinherited

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

SourceFolder

FolderTarget SourceFolder

getsetinherited

Specifies the source folder from which the files are copied. For information about how to specify a folder in different file systems, see FolderTarget.

FolderNameVariable

string FolderNameVariable

getsetinherited

Saves the folder name to a variable.

OverwriteFolderOperation

OverwriteFileOperation OverwriteFolderOperation

getsetinherited

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

• Replace: Specifies that the new content is saved to a file that replaces the existing file.
• 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.
• Merge: Merges the contents with the existing folder.

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:

• MoveFolderAction.Properties.cs