Read File

The Read File activity is used to read a file and place its contents into the activity’s output.

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.
Exclude File Content	No	Specifies not to load the data from the file into this activity’s output. If this field is checked, the contents of the file are not available to subsequent activities in the process definition.
Read as	Yes	The type of content in the file. Can be either text or binary.

The name to appear as the label for the activity in the process definition.

Description

Short description of the activity.

Exclude File Content

Specifies not to load the data from the file into this activity’s output. If this field is checked, the contents of the file are not available to subsequent activities in the process definition.

Read as

Yes

The type of content in the file. Can be either text or binary.

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
fileName	string	The path and name of the file to read.
encoding	string	The character encoding for text files. This element is only available when the Read as field on the Configuration tab is set to text. Encoding names supported by Java can be specified in this element. If this element is not specified, the default encoding of the Java Virtual Machine used by the process engine is used.

The path and name of the file to read.

encoding

string

The character encoding for text files. This element is only available when the Read as field on the Configuration tab is set to text. Encoding names supported by Java can be specified in this element. If this element is not specified, the default encoding of the Java Virtual Machine used by the process engine is used.

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.
fullName	string	The name of the file, including the path information.
fileName	string	The name of the file without the path information.
location	string	The path to the file.
configuredFileName	string	This element is optional and it is not populated by this activity.
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.
fileContent	complex	Element containing the textContent and binaryContent data.
textContent	string	Contents of the file (text files), if the Exclude File Content field is not checked on the Configuration tab.
binaryContent	binary	Contents of the file (binary files), if the Exclude File Content field is not checked on the Configuration tab.
encoding	string	The character encoding for the file.

Element containing the fileName, location, type, readProtected, writeProtected, and size data.

fullName

string

The name of the file, including the path information.

fileName

string

The name of the file without the path information.

location

string

The path to the file.

configuredFileName

string

This element is optional and it is not populated by this activity.

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.

fileContent

complex

Element containing the textContent and binaryContent data.

textContent

string

Contents of the file (text files), if the Exclude File Content field is not checked on the Configuration tab.

binaryContent

binary

Contents of the file (binary files), if the Exclude File Content field is not checked on the Configuration tab.

encoding

string

The character encoding for the file.

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 file does not exist.
UnsupportedEncodingException	The text file’s encoding is not valid and the content of the file is read into process data.
FileIOException	An I/O exception occurred when trying to read the file.

Exception

Thrown When...

FileNotFoundException

The file does not exist.

UnsupportedEncodingException

The text file’s encoding is not valid and the content of the file is read into process data.

FileIOException

An I/O exception occurred when trying to read the file.