Copyright © Cloud Software Group, Inc. All Rights Reserved

List Files

Activity

The List Files activity returns information about files or directories, or a listing of all the files in the specified directory.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Mode	No	The type of listing you would like to retrieve. The following are the choices for this field: • directories-only • files-only • files-and-directories

Input

The input for the activity is the following.

Input Item	Datatype	Description
fileName	string	The path and name of the directory with files or subdirectories to list. If you supply a file or directory name, information about that file or directory is returned. You can use wildcards to list files or directories that match the given specification. For example, C:\files\*.log lists any file in the files directory that have a .log extension. C:\files\mylogs\*.* lists all files in the directory mylogs.

Output

The output for the activity is the following.

Output Item	Datatype	Description
fileInfo	complex	Element containing the fileName, location, type, readProtected, writeProtected, and size data. This is a repeating element. Each item in the element is a file or directory contained in the specified directory that matches the given criteria.
fullName	string	The name of the file, including the path information.
fileName	string	The name of the file without the path information.
configuredFileName	string	The name of the file or directory this activity is configured to operate on.
location	string	The path to the file.
type	string	The file type.
readProtected	boolean	Whether the file is read-protected.
writeProtected	boolean	Whether the file is write-protected.
size	integer	Size of the file in bytes.
lastModified	string	Time stamp indicating when the file was last modified. You can compare values in this element using the compare-dateTime() XPath function. For example,   compare-dateTime($List-Files/ ListFilesActivityOutput/files/ fileInfo[fileName="myFile.txt"]/ lastModified, current-dateTime())

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
FileNotFoundException	The specified path is not found.

 

Copyright © Cloud Software Group, Inc. All Rights Reserved