Versions Compared

Old Version 4

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version Current

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 24.0
Hint_designer
PageDESIGNER:Filesystem Adapter
TopicFilesystem Adapter
Builder 7 The usage of file system access is represented by two aliases: a directory alias (having stereotype <<DirectoryAlias>>) and a file alias (having stereotype <<FileAlias>>). They are connected to the service composite by a dependency.

Figure: File System Component Diagram

The alias FileAlias represents a certain file, the alias DirectoryAlias represents a certain directory on the file system. On both you can use relative paths - they will be relative to the service directory on the E2E Bridge, then.

The directory alias can define a base directory and a default file encoding:

  • The default file encoding can be overridden per adapter call using a dynamic encoding parameter, e.g. on File System Adapter calls reading lines, or with the Flat File Adapter.
  • Regarding the base directory, the file name parameter will be treated as a path relative to this directory on the File System Adapter call. Jumping out of the base directory by ../../aDirectory tricks is impossible. The base directory can be changed in the service settings on the E2E Bridge, however.

See also Directory Alias and Dynamic File Access for an example of using the directory alias with dynamic file access.

Using a file resource, neither file encoding nor file path can be overridden.

Tagged Values

<<DirectoryAlias>>

Multiexcerpt include
MultiExcerptNamedirectory_alias
PageWithExcerptFile System

<<FileAlias>>

Multiexcerpt include
MultiExcerptNamefile_alias
PageWithExcerptFile System

File System Components of Builder Version 6

Deprecated since Builder 7

Expand
titleClick here to read the documentation of the component diagram used in Builder releases before 7 ...

The use of file system access is represented by the two aliases DirectoryAlias and FileAlias. Both have the stereotype <<FileSystemAlias>>. They are connected to the service composite by a dependency.

Figure: File System Component Diagram

The alias FileAlias represents a certain file. It has three tagged values:

  • fileName: The file name of the file you want to access.

  • directory: The path to the file.

  • charset: The charset definition of the file.

The alias DirectoryAlias represents a certain directory on the file system. Hence, only the tagged value directory has to be defined.

Tagged Values of the <<FileSystemAlias>>

In general, a <<FileSystemAlias>> can have four tagged values:

Tagged ValueDescriptionAllowed Values
fileNameSpecify the name of the file you want to access. Leave this tagged value empty, if you want to access a directory.Example:myFile.txt
directorySpecify the path to the file or directory.Example:.\tmp\testDirectory
charset

Specify the charset of the file. Refer to Charset Definitions for possible values.

If the alias refers to a directory, specifying charset is superfluous.

default

iso-8859-1

resource

Instead of a fileName, you can select a resource from the list of imported resources. The File System Adapter will then use the resource instead of directory/fileName.
The resource can be replaced changing the resource path in the File System Adapter settings of the xUML service.

See Importing File Resources for more information on importing resources and xUML Service Settings for more information on changing the settings of a service.


Otp
Floatingfalse

Rp