• Article

File System Task Editor (General Page)

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 Variables and Using Variables in Packages.

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.

Options

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

    Value

    Description

    True

    The destination path is stored in a variable. Selecting this value displays the dynamic option, DestinationVariable.

    False

    The 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.

    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.

    Value

    Description

    Copy directory

    Copy a directory. Selecting this value displays the dynamic options for a source and destination.

    Copy file

    Copy a file. Selecting this value displays the dynamic options for a source and destination.

    Create directory

    Create a directory. Selecting this value displays the dynamic options for a source and a destination directory.

    Delete directory

    Delete a directory. Selecting this value displays the dynamic options for a source.

    Delete directory content

    Delete the content of a directory. Selecting this value displays the dynamic options for a source.

    Delete file

    Delete a file. Selecting this value displays the dynamic options for a source.

    Move directory

    Move a directory. Selecting this value displays the dynamic options for a source and destination.

    Move file

    Move a file. Selecting this value displays the dynamic options for a source and destination.

    NoteNote
    When moving a file, do not include a file name in the directory path that you provide as the destination.

    Rename file

    Rename a file. Selecting this value displays the dynamic options for a source and destination.

    NoteNote
    When renaming a file, include the new file name in the directory path that you provide for the destination.

    Set attributes

    Set 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

    True

    The destination path is stored in a variable. Selecting this value displays the dynamic option, SourceVariable.

    False

    The destination path is specified in a File connection manager. Selecting this value displays the dynamic option, DestinationVariable.

IsDestinationPathVariable Dynamic Options

IsDestinationPathVariable = True

IsDestinationPathVariable = False

IsSourcePathVariable Dynamic Options

IsSourcePathVariable = True

IsSourcePathVariable = False

Operation Dynamic Options

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.