Filesystem: Move a file Transformer

iPaaS Documentation Transformers
1

Table of contents

  • General description
  • The different parts of the “Filesystem: Move a file” Transformer

General description

The “Filesystem: Move a file” Transformer can be used to move a file from one directory into another one, and to move a file from one filesystem to another filesystem.

The different parts of the “Filesystem: Move a file” Transformer

  • Path of the file (required field)
    This specifies the location on the “source filesystem” where the file to be moved can be found. Supports placeholders to use file names from the entity data.

  • Source filesystem (required field)
    This specifies the filesystem where the original file is located.

  • Destination filesystem
    This helps select the filesystem where the file will be moved to. By default, the filesystem selected as “source filesystem” will be used. This allows users to move a file on the same filesystem. By selecting a different filesystem users can move a file across filesystems. For example, you can move a file from an FTP server to a S3 bucket.

  • Destination directory
    This defines the path where the file will be moved to on the “destination filesystem”. By default, the root directory configured on the selected filesystem will be used.

  • When the destination exists
    This helps specify the action to take if a file with the same name already exists on the destination filesystem. The actions to choose from include:

    • Skip
      This option results in not moving the file.
    • Overwrite
      This option results in moving the file by replacing the existing file on the destination filesystem.
    • Rename
      If a file already exists with a similar name on the target filesystem, then Alumio tries to find a filename that does not exist on the target system to prevent overwriting existing files.

  • Rename strategy
    This field becomes available when the “Rename” option is picked and is required. It describes how Alumio is going to react when a file with the same name already exists and how the new filename will be created.

When the strategy “Add an increasing number to the filename” is picked, extra fields will become available to configure the behavior:

  • Template for destination
    This is a template with placeholders that tells Alumio where to place the file and how to name it. Available tokens are {dirname}/{filename}-{counter}.{extension}

  • Format for the number
    This specifies how the number is formatted. For example, with a certain amount of leading zeros.

  • Number to start
    This sets the starting number if the destination file already exists. For example, instead of starting at 0, you might configure it to start at 1000.

  • Always add a number, even when the destination does not exist
    If this is checked, this “Rename” strategy is applied to all files. The first file should then start with a 0 (zero) or with the number to start if that override has been configured.

image
image2870×1306 258 KB