Class FileOperationTaskSettings

Namespace

ArcanaDevelopment.adTempus.Shared.FileOperations

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Base class for task settings for a FileOperationTask

[DataContract]
public abstract class FileOperationTaskSettings

Inheritance

object

FileOperationTaskSettings

Derived

BasicFileTransferSettings

FileCompressionSettings

Properties

BackupBeforeOverwrite

Specifies whether to back up existing files before overwriting them

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool BackupBeforeOverwrite { get; set; }

Property Value

bool

Remarks

This option only applies when the OverwriteOption is set to one of the Overwrite values.

This option is only supported for local, FTP, and SFTP targets. Backup is not supported for cloud file providers.

ClearArchiveFlag

Clear the Archive flag (bit) after the operation completes.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool ClearArchiveFlag { get; set; }

Property Value

bool

Remarks

This option is not supported for all file sources

ExcludeFiles

List of files to exclude from the operation

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public List<string> ExcludeFiles { get; }

Property Value

List<string>

IncludeFiles

List of files or patterns to include in the operation

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember(Name = "Files")]
public List<string> IncludeFiles { get; }

Property Value

List<string>

Remarks

If SourceDirectory is set, each file name must be specified relative to that directory. Otherwise each file name must be specified relative to the root of the provider (e.g., the full path and name for a local file; the full path relative to the user's home directory for an ftp connection).

MaintainDirectoryStructure

Indicates whether the source directory structure is maintained when files are transferred to the target. If true the directory structure is recreated under the TargetName. If false all files are written to the TargetName

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool MaintainDirectoryStructure { get; set; }

Property Value

bool

ModifiedWithin

Only select files modified within the specified timespan prior to the operation execution

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public TimeSpan? ModifiedWithin { get; set; }

Property Value

TimeSpan?

OperationType

A string constant indicating the operation type.

public abstract string OperationType { get; }

Property Value

string

OverwriteOption

Specifies the behavior when a file being transferred already exists on the target

[DataMember]
[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
public FileOverwriteOption OverwriteOption { get; set; }

Property Value

FileOverwriteOption

See Also

BackupBeforeOverwrite

SelectArchiveFlagOnly

Only select files with the Archive flag (bit) set

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool SelectArchiveFlagOnly { get; set; }

Property Value

bool

Remarks

This option is not supported for all file sources

SelectModifiedSince

Only select files modified since the specified date/time (in UTC)

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public DateTime? SelectModifiedSince { get; set; }

Property Value

DateTime?

SelectModifiedSinceVariable

Only select files modified since the date/time (in UTC) defined in the specified variable

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public string SelectModifiedSinceVariable { get; set; }

Property Value

string

Remarks

If used, SelectModifiedSinceVariable must be set to the name of a JobVariable that will resolve to a date/time value at runtime

SourceDirectory

The root directory for the IncludeFiles

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public string SourceDirectory { get; set; }

Property Value

string

Remarks

If specified, the IncludeFiles are resolved relative to this directory. If SourceDirectory is not specified, each include file must be a fully-qualified name.

SourceRecursive

Indicates whether to operate recursively on the SourceDirectory

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool SourceRecursive { get; set; }

Property Value

bool

TargetName

The destination directory for file transfers, extractions, etc.

[ExtensionMember(IncludeInSearch = true, IncludeInProjection = true)]
[DataMember]
public string TargetName { get; set; }

Property Value

string

Methods

DoValidation(MessageCollection)

Performs validation of the settings

public virtual void DoValidation(MessageCollection messages)

Parameters

Name	Type	Description
messages	MessageCollection	Collection of messages that any validation messages will be added to