File Operation

File operation tasks perform standard file operations.

All of the fields described in this page are specific to this service. To get general information for setting up a task, see Tasks.

File Operation Properties

This table describes the File Operation task properties:

The fields that will be displayed to the user will vary based on the operation being performed.

Field

Description

Operation

Operation to perform.

The remaining fields change based on the Operation type. This table discusses the fields based on Operation type:

Operation	Field	Description
Create File	Source File	Fully qualified path of where the file will be created.
	File Contents	Data to add to the specified file.
	Create target directory if it doesn't exist	Option to create a directory if one does not already exist in the path.
	Use CRLF for new lines	Option to append the Carriage Return (CR) and Line Feed (LF) characters at the end of each line of the file to start a new line.
	Overwrite existing file(s)	Option to overwrite any existing files of the same name.
Delete file(s)	Source File(s)	Fully qualified path of the file or files to be deleted.
	Older than	Indicates that files older than the specified number of hours are deleted.
	Fail task if no operation is performed	Option to fail this task if no operation is performed by the task.
Move file(s)	Source File(s)	Fully qualified path where the file is stored.
	Target Path	Fully qualified path where the file is to be moved to.
	Create target directory if it doesn't exist	Option to create a directory if one does not already exist in the path.
	Overwrite existing file(s)	Option to overwrite any existing files of the same name.
	Fail task if no operation is performed	Option to fail this task if the file(s) are not moved.
Copy file(s)	Source File(s)	Fully qualified path where the file is stored.
	Target Path	Fully qualified path where the file is to be copied to.
	Create target directory if it doesn't exist	Option to create a directory if one does not already exist in the path.
	Overwrite existing file(s)	Option to overwrite any existing files of the same name.
	Fail task if no operation is performed	Option to fail this task if no files are copied.
Append data to file	Source File	Fully qualified path where the file is stored.
	File Contents	Data to add to the end of this file.
	Create target directory if it doesn't exist	Option to create a directory if one does not already exist in the path.
Retrieve file contents	Source File	Fully qualified path where the file is stored.
	Fail task if no operation is performed	Option to fail this task if the file contents are retrieved.
Create directory	Source Path	Fully qualified path where to create the directory.
	Fail task if no operation is performed	Option to fail this task if no directory is created.
Remove directory and its contents	Source Path	Fully qualified path where to create the directory.
	Fail task if no operation is performed	Option to fail this task if the directory and contents are not deleted.
Remove directory if empty	Source Path	Fully qualified path where to create the directory.
	Fail task if no operation is performed	Option to fail this task if the operation is not performed.
Rename file	Source File	Enter the fully qualified path where the file is stored.
	Target File	New name.
	Fail task if no operation is performed	Option to fail this task if the file is not renamed.
Retrieve file attributes	Source File	Fully qualified path where the file is stored.
	Fail task if no operation is performed	Option to fail this task if the file attributes are not retrieved.
List	Source Path	Fully qualified path where the files to be listed are stored.
	Include Files	Option to include all files in the specified source path in the list.
	Include Folders	Option to include all folders in the specified source path in the list.
	Max Files	Maximum number of files to be returned in the list. The comma delimited text returned from this task can be passed into a broadcast task/process and having this limit makes it so that there will be a controlled number/limit of items that will be created for the broadcast task/process.
	Columns	Columns to included in the list for each file. These are the valid columns: File Name Path Full Path Last Accessed Modified Created
	Sort by	Option to sort files returned in the list based on a particular column.
	Filter files by date and time	Option to filter the files returned in the list.
	Type	The date type to filter on. Filtering used Operator and Value fields. These are the valid options: Accessed Modified Created (Windows only)
	Operator	Operator to apply to the date filtering. These are the valid options: After Before
	Value	Date and time used for date filtering in the format mm/dd/yyyy hh:mm
Encrypt File	Source File	Fully qualified path to the location where the file is stored.
	Target File	Optional. The name, including the fully qualified path, where the encrypted file is stored. If no value is specified, then the value of the Source File field (appended with .pgp) is used. For example, C:\temp\file.txt.pgp.
	Key Login	The PGP Key login that contains the public key information used to encrypt the file.
	ASCII Armor	Option to output the data in ASCII Armor format.
	Add Signature	Option to sign the file when it is encrypted. Requires both the public key for encryption and the private key for signing in the Key Data field for the PGP Key Login assigned to this task.
Decrypt File	Source File	Fully qualified path to the location where the file is stored.
	Target File	Optional. The name, including the fully qualified path, where the decrypted file is stored. If no value is specified, the value used will be the name of the original unencrypted file located in the same directory as the Source File.
	Key Login	The PGP Key login that contains the private key information used to decrypt the file.
Sign file	Source File	Fully qualified path to the location where the file is stored. For example, C:\temp\file.txt.
	Target File	Optional. The name, including the fully qualified path, where the signed file will be stored. If no value is specified, then the value of the Source File field (appended with .pgp) is used. For example, C:\temp\file.txt.pgp.
	Key Login	The PGP Key login that contains the private key information used to sign the file.
	ASCII Armor	Option to output the data in ASCII Armor format.
	Compress	Option to compress the contents of the signed file.
Verify file	Source File	Fully qualified path to the location where the signed file is stored.
	Target File	The name, including the fully qualified path, where the verified copy of the file is stored. This field is available only when the Save Contents check box is selected.
	Key Login	The PGP Key login that contains the public key information used to verify the file.
	Save Contents	Option to save the verified file contents to the file specified in the Target File field.

See Creating a Process to add this task to a process.