Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fixed excerpt

Tagged Values

<<DirectoryAlias>>

Multiexcerpt
MultiExcerptNamedirectory_alias
Tagged ValueDescriptionAllowed Values
directorySpecify a path to a directory. This directory will be treated as a base directory. It will be either used directly (for a File System Adapter operating directly on directories), or as a base directory for a path segment given by a dynamic file name parameter. It is not possible to jump out of the base directory by ../../aDirectory tricks. The base directory can only be changed in the service settings on the E2E Bridge.Example:./tmp/testDirectory
fileEncodingSpecify the default encoding be used with the directory. This default encoding can be overwritten on adapter calls, using a dynamic encoding parameter, e.g. on File System Adapter calls reading lines, or with the Flat File Adapter.Refer to Charset Definitions for possible values.
defaultiso-8859-1

<<FileAlias>>

Multiexcerpt
MultiExcerptNamefile_alias
Tagged ValueDescriptionAllowed Values
fileSpecify name and path of the file you want to access.Example:.tmp/testDirectory/testFile.txt
encodingSpecify the encoding of the file.Refer to Charset Definitions for possible values.
defaultiso-8859-1
resource

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

Info
iconfalse

If resource is specified neither file nor encoding can be overridden dynamically.

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

Parameters File Handling

Action "read"

Multiexcerpt
MultiExcerptNameread
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to read, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

positionIntegerinPosition (in Bytes) from which you want to start reading the file.
lengthIntegerin/outLength (in Bytes) of the snippet of the file you want to read. The actual length of the read data is given back (e.g. on file end).
dataBloboutContent that has been read.

Action "readLine"

Multiexcerpt
MultiExcerptNamereadLine
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to read, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

encodingStringinEncoding of the file. Default encoding is iso-8859-1.
For a list of possible encodings see Charset Definitions.
lineStringoutFile content of the line that has been read. On file end, line is NULL.
lengthIntegeroutLength (in Bytes) of the line that has been read. On file end, length is 0.

Action "write"

Multiexcerpt
MultiExcerptNamewrite
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to write, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

positionIntegerinPosition (in Bytes) from which you want to start writing the file.
dataBlob
Content you want to write to the file.
lengthIntegerinLength (in Bytes) of the data you want to write, if you want to only write part of the Blob.

Action "append"

Multiexcerpt
MultiExcerptNameappend_modes

To action append, two modes can be applied:

  • append
    If mode is empty or set to append, the content stored in data will be appended to the file specified in name. If the file does not exist, it will be created.
  • overwrite
    If mode is set to overwrite, the file specified in name will be overwritten with the content stored in data. If the file does not exist, it will be created.
    overwrite will only be applied to the first append. All subsequent appends (e.g. in a loop) automatically get mode append.
Multiexcerpt
MultiExcerptNameappend
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to write, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

dataBlobinContent you want to write to the file.
lengthIntegerinLength (in Bytes) of the data you want to append, if you want to only write part of the Blob.

Action "status"

Multiexcerpt
MultiExcerptNamestatus
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file/directory you want to read, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

typeStringoutType of accessed element (File or Directory).
sizeIntegerout

Size of the file in Bytes.

Info
iconfalse

size is meaningless for directories, as it is not the combined size of all contained files and subfolders, but rather some constant defined by the operating system (e.g. 0 or 4096).

accessTimeDateTimeoutTimestamp when the file/directory was accessed for the last time.
creationTimeDateTimeoutTimestamp when the file/directory was created.
modificationTimeDateTimeoutTimestamp when the file/directory was modified for the last time.

Action "rename"

Multiexcerpt
MultiExcerptNamerename
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to rename, including the path.

newNameStringin

New name you want to rename the file to. We recommend to provide a fully qualified file name (including the path).

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

Action "remove"

Multiexcerpt
MultiExcerptNameremove
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to remove, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

Action "Copy"

Multiexcerpt
MultiExcerptNamecopy
NameTypeDirectionDescription
sourceStringin

Fully qualified file name of the file you want to copy, including the path.

targetStringin

Fully qualified file name of the target file, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts


Action "close"

Multiexcerpt
MultiExcerptNameclose
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the file you want to close, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

Parameters Directory Handling

Action "readDirectory"

Multiexcerpt
MultiExcerptNamereadDirectory
NameTypeDirectionDescription
nameStringin

Fully qualified path to the directory you want to read.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

entriesArray of StringoutreadDirectory returns an array of Strings containing the directory names. The array elements will not contain the directory prefix (path).

Action "createDirectory"

Multiexcerpt
MultiExcerptNamecreateDirectory
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the directory you want to create, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts

Action "status"

Multiexcerpt include
MultiExcerptNamestatus
PageWithExcerptFile System

Action "remove"

Multiexcerpt
MultiExcerptNameremove_directory
NameTypeDirectionDescription
nameStringin

Fully qualified file name of the directory you want to remove, including the path.

Info
iconfalse

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehint_backslash_in_path
nopaneltrue
PageWithExcerptINTERNAL:_bridge_excerpts