TechNet
Export (0) Print
Expand All

File System Task Editor (General Page)

 

Applies To: SQL Server 2016

Use the General page of the File System Task Editor dialog to configure the file system operation that the task performs.

To learn about this task, see File System Task.

You must specify a source and destination connection manager by setting the SourceConnection and DestinationConnection properties. You can either provide the names of File connection managers that point to the files that the task uses as a source or destination, or if the paths of the files are stored in variables, you can provide the names of the variables. To use variables to store the file paths, you must set first set the IsSourcePathVariable option for the source connection and the IsDestinationPatheVariable option for the destination connection to True. You can then choose the existing system or user-defined variables to use, or you can create new variables. In the Add Variable dialog box, you can configure and specify the scope of the variables. The scope must be the File System task or a parent container. For more information see, Integration Services (SSIS) Variables and Use Variables in Packages.

System_CAPS_ICON_note.jpg Note


To override the variables you selected for the SourceConnection and DestinationConnection properties, enter an expression for the Source and Destination properties. You enter expressions on the Expressions page of the File System Task Editor. For example, to set the path of the files that the task uses as a destination, you may want to use variable A under certain conditions and use variable B under other conditions.

System_CAPS_ICON_note.jpg Note


The File System task operates on a single file or directory. Therefore, this task does not support the use of wildcard characters to perform the same operation on multiple files or directories. To have the File System task repeat an operation on multiple files or directories, put the File System task in a Foreach Loop container. For more information, see File System Task.

You can use expressions to use different variables for the

IsDestinationPathVariable
Indicate whether the destination path is stored in a variable. This property has the options listed in the following table.

ValueDescription
TrueThe destination path is stored in a variable. Selecting this value displays the dynamic option, DestinationVariable.
FalseThe destination path is specified in a File connection manager. Selecting this value displays the dynamic option, DestinationConnection.

OverwriteDestination
Specify whether the operation can overwrite files in the destination directory.

Name
Provide a unique name for the File System task. This name is used as the label in the task icon.

System_CAPS_ICON_note.jpg Note


Task names must be unique within a package.

Description
Type a description of the File System task.

Operation
Select the file-system operation to perform. This property has the options listed in the following table.

ValueDescription
Copy directoryCopy a directory. Selecting this value displays the dynamic options for a source and destination.
Copy fileCopy a file. Selecting this value displays the dynamic options for a source and destination.
Create directoryCreate a directory. Selecting this value displays the dynamic options for a source and a destination directory.
Delete directoryDelete a directory. Selecting this value displays the dynamic options for a source.
Delete directory contentDelete the content of a directory. Selecting this value displays the dynamic options for a source.
Delete fileDelete a file. Selecting this value displays the dynamic options for a source.
Move directoryMove a directory. Selecting this value displays the dynamic options for a source and destination.
Move fileMove a file. Selecting this value displays the dynamic options for a source and destination. When moving a file, do not include a file name in the directory path that you provide as the destination.
Rename fileRename a file. Selecting this value displays the dynamic options for a source and destination. When renaming a file, include the new file name in the directory path that you provide for the destination.
Set attributesSet the attributes of a file or directory. Selecting this value displays the dynamic options for a source and operation.

IsSourcePathVariable
Indicate whether the destination path is stored in a variable. This property has the options listed in the following table.

Value
TrueThe destination path is stored in a variable. Selecting this value displays the dynamic option, SourceVariable.
FalseThe destination path is specified in a File connection manager. Selecting this value displays the dynamic option, DestinationVariable.

IsDestinationPathVariable = True

DestinationVariable
Select the variable name in the list, or click <New variable...> to create a new variable.

Related Topics: Integration Services (SSIS) Variables, Add Variable

IsDestinationPathVariable = False

DestinationConnection
Select a File connection manager in the list, or click <New connection...> to create a new connection manager.

Related Topics: File Connection Manager, File Connection Manager Editor

IsSourcePathVariable = True

SourceVariable
Select the variable name in the list, or click <New variable...> to create a new variable.

Related Topics: Integration Services (SSIS) Variables, Add Variable

IsSourcePathVariable = False

SourceConnection
Select a File connection manager in the list, or click <New connection...> to create a new connection manager.

Related Topics: File Connection Manager, File Connection Manager Editor

Operation = Set Attributes

Hidden
Indicate whether the file or directory is visible.

ReadOnly
Indicate whether the file is read-only.

Archive
Indicate whether the file or directory is ready for archiving.

System
Indicate whether the file is an operating system file.

Operation = Create directory

UseDirectoryIfExists
Indicates whether the Create directory operation uses an existing directory with the specified name instead of creating a new directory.

Integration Services Error and Message Reference
Expressions Page

Community Additions

ADD
Show:
© 2016 Microsoft