Writing a File

This page explains the Filesystem Adapter in Bridge context. If you were looking for the same information regarding the PAS Designer, refer to Filesystem Adapter in the Designer guide.

Parameters of Action "write"

Name	Type	Direction	Description
name	String	in	Fully qualified file name of the file you want to write, including the path. When using the Windows style with backward slashes "\" you have to be aware that you have escape this character. The escape character is also the "\". To avoid this, use forward slashes with Windows as well.
position	Integer	in	Position (in Bytes) from which you want to start writing the file.
data	Blob		Content you want to write to the file.
length	Integer	in	Length (in Bytes) of the data you want to write, if you want to only write part of the Blob.

Defining a "write" Action

To write a file with the file system adapter, you need to define a write action on an action having the stereotype <<FileSystemAdapter>>. You can do this manually (refer to Figure: The Specification Dialog of the File System Adapter) or with the help of the E2E Action Wizard (see context menu of the action node).

Figure: Writing a File

The file content needs to be provided as input of type Blob. The input object buffer must be named data.

The directory where the file should be created and the file name are defined in the component diagram. The link from the activity diagram to the physical information is established by an alias (in the present example: FileAlias). See File System Components for more information on file system aliases.
For information on how to access a file or directory dynamically refer to Dynamic File System Access.

The directory has to be created before the file can be written (see chapter Creating a Directory). If the directory is not created, error message FSADSM 22 ("Failed creating file") will be reported (refer to Catching Errors).

Related Error Codes

Find a list of all File System Adapter error codes on System Errors of the File System Adapter.

Error Code	Description
`FSASDM/22`	Failed creating file. Either the directory where the file should be written to, is not created, or the filename is too long (Windows limitation).

Writing Data to a Specified Position in a File

With the <<FileSystemAdapter>>, you can write data to a specified position within a file. You also need to define a write action (refer to Figure: The Specification Dialog of the File System Adapter). The only difference is, that you need to define a second input parameter. The parameter must be called position and is of type Integer. It defines the byte position within a file, at which the new content is written. Depending on the length of the new data, this will result in a partly update of the file content or an extension of the file. This can be useful when appending data to log files.

By retrieving the size of the file with the status action (see next chapter), you could easily append data to the file by determining the end position of the file and writing new content at this position.

Figure: Writing Data at a Specified Position

Related Pages:

Catching Errors