X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

File System

This adapter stores, reads, deletes, copies, moves, lists files and folders or attaches files to a target file located in the file system of the X4 server or on connected Windows or Samba network drives.

The File System adapter must not be used to modify files in the X4 repository, since it does not access the X4 repository but the file system directly. If the adapter is used for this purpose, error messages and malfunctions may occur.
To modify files in the X4 repository, use the adapter Projects or Project Access.

Properties


Operation

Defines the operation executed by the adapter

Possible values:

  • Write File: Write data from the previous process step to the target file defined in the path parameter.

  • Append File: Append file from the previous process step to the target file defined in the path parameter.

    If the target file defined in the path parameter does not exist, a file will be created.


  • Read File: Read file defined in the path parameter.

  • Delete: Delete files or folders defined in the path parameter.

  • Copy: Copy files or folders defined in the path parameter to the folder defined in the targetPath parameter.

  • Move: Move files or folders defined in the path parameter to the folder defined in the targetPath parameter.

  • Exist: Check whether the files or folders defined in the path parameter exist. Outputs an XML with metadata as a result.

  • Create Folder: Creates the folder defined in the path parameter.

  • List Folder: Lists names and metadata of files and folders from the folder defined in the path parameter. Outputs an XML with metadata as a result.

    The content of the files is not listed.

Parameters


Adapter

Adapter main class (do not change!)

Possible values:

  • de.softproject.integration.adapter.filesystem.FileSystemAdapter: Main class (default)

path

Path to a file or folder in the file system of the X4 server or to a connected Windows or Samba network drive. To do this, the X4 server requires appropriate permissions on the destination folder.

Possible values:

  • Any string, if necessary including placeholders and file extension e.g. %USER_COLLECTION%/Data/Input.xml

  • c:/: Access the W Windowssystem partition C:\.

  • Any UNC network drive specification according to the scheme  \\\\Server\\\share\\public\folder\\\ with any spaces and special characters e.g. \\\\SP-PM-01\\share\\Public Folder\\ 

targetPath

Additional path to a file or folder in the file system of the X4 server  or to a connected Windows or Samba network drive. To do this, the X4 server requires appropriate permissions on the destination folder.

This parameter is used only for Move and Copy operation.

Possible values:

  • Any string, if necessary including placeholders and file extension e.g. %USER_COLLECTION%\Data\Input.xml

  • c:\  Access the Windows system partition C:\.

  • Any UNC network drive specification according to the scheme  \\\\Server\\\share\\public\folder\\\ with any spaces and special characters e.g. \\\\SP-PM-01\\share\\Public Folder\\ 

nameFilter

Filters the output of the ListFolder operation by name

Possible values:

  • Any string (e.g. myFolder )

  • Wildcard *

  • Semicolon ; as separator for several values (e.g. *.txt; *.pdf)

addNewline

Inserts a new line in the destination file on top of the file to be appended. Can be used only with the Append File operation.

Possible values:

  • None: (default) Does not insert a new line.

  • Auto: Inserts a new line if no new line was inserted before. Detects the format of an already inserted new line.

  • Windows: Inserts a new line in Windows format.

  • Unix: Inserts a new line in Unix format.

Status values

1

The adapter operation was executed successfully.

-1

The operation failed due to a technical error.