Copyright © Cloud Software Group, Inc. All Rights Reserved

Write File

Activity

The Write File activity writes content to the specified file.

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.
Append	Yes	Appends contents to an existing file. If unchecked, the file is overwritten.
Write as	Yes	Specifies the type of file content to write: text or binary.
Create Non-Existing Directories	Yes	When checked, the activity creates all directories in the specified path, if they do not already exist. If this field is unchecked and there are one or more directories in the specified path that do not exist, an exception is raised.
Compress	No	Specifies whether to compress the output file using GZip format. Specify None for no compression or GZip for a compressed output file. When you specify GZip for this field, you must rename the file to use the .gz suffix and use gunzip to uncompress the file.

Input

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. Wildcards are not permitted in this field.
textContent	string	Contents of the file (text files).
binaryContent	binary	Contents of the file (binary files).
addLineSeparator	boolean	Specifies whether to add a carriage return after each input line.
encoding	string	The character encoding for text files. This element is only available when the Write 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.

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

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 file does not exist.
UnsupportedEncodingException	The encoding is not valid.
FileIOException	An I/O exception occurred when trying to write to the file.

Copyright © Cloud Software Group, Inc. All Rights Reserved