Output configuration properties are as follows:

Output Directory

Applies to...
  • Operational Mode: Output.
  • Connection Type: FTP, FTPS, SFTP.

Output Directory specifies the directory to place output messages. The base output directory is used as the target for uploading files (note that the Base Filename may specify additional sub-directories). It is possible to configure the output directory as either an absolute or relative path, however, the FTP server determines how these paths are interpreted. Some FTP servers treat the path as relative to the user's home directory, whereas others treat an absolute path as truly absolute.

The output directory defaults to the home directory. You require write access to the selected directory.

Base Filename

Applies to...
  • Operational Mode: Output, Out->In.
  • Connection Type: FTP, FTPS, SFTP.

Base Filename specifies the base filename to use when uploading the file. This includes the full filename, but excludes the suffix (file extension), and may contain additional sub-directories separated by forward slashes or back slashes if required. The base filename is interpreted as relative to the configured output directory.

When set, the base filename and optional suffix are retrieved from the Base Filename and Filename Suffix configuration properties respectively when the message properties BaseFilename and Suffix are not set in the incoming message. When these message properties are set, they override the corresponding static configuration properties regardless of whether the communication point is used in dynamic mode. Refer to Dynamic Configuration Using Message Properties for details.

Unlike the deprecated FTP Client communication point, for the (S)FTP Client communication point the dynamic replacement of the Base Filename configuration property only occurs when the BaseFilename message property is set in the incoming message and the Base Filename configuration property is set to $BaseFilename.

Thereafter, the other naming options are applied to the filename (for example, Append Date/Time to Filename, Duplicate Filename Behaviour, etc.).

Filename Suffix

Applies to...
  • Operational Mode: Output, Out->In.
  • Connection Type: FTP, FTPS, SFTP.

Filename Suffix specifies the optional suffix to append to the end of the filename when uploading the file. The suffix is appended to the generated filename prior to performing the upload, and does not need to be configured using a leading dot (any leading dot in the configured suffix is stripped as one is automatically added when generating the final filename).

Duplicate Filename Behaviour

Applies to...
  • Operational Mode: Output, Out->In.
  • Connection Type: FTP, FTPS, SFTP.

Duplicate Filename Behaviour is a mode that determines what action the communication point takes if it finds that its target filename is already in use.

Property Option
Description
Rename the file Rhapsody tries to generate a unique file name by appending (1), (2), etc., to the base filename until a name is found that is not on the remote server.
Append date and time to filename

Rhapsody appends the current date/time to the base filename in the format yyyy-MM-dd-HH-mm-ss-SSS.

Don't check for duplicates

Any file with the same name on the remote server is overwritten.

Append to existing file

If there is a file with the same name on the remote server, Rhapsody appends the data to the existing file.

† Default option.

If the active duplicate behavior mode resolves to the append to file option, then the settings for the Append Date/Time and Use Temp Files configuration parameters are ignored and both are effectively disabled.

Append Date/Time

Applies to...
  • Operational Mode: Output, Out->In.
  • Connection Type: FTP, FTPS, SFTP.
  • Duplicate Filename Behaviour: Rename the file, Don't check for duplicates, Append to existing file.

Append Date/Time appends the current date-time to the base filename in the format yyyy-MM-dd-HH-mm-ss-SSS.

This option is not available if Append to existing file is selected in Duplicate Filename Behaviour.

Property Option
Description
Do not append date and time Does not append the current date/time to the base filename.
Append date and time to filename

Appends the current date/time to the base filename in the format dictated by Append Date/Time Format (yyyy-MM-dd-HH-mm-ss-SSS by default).

† Default option.

Append Date/Time Format

Applies to...
  • Operational Mode: Output, Out->In.

  • Connection Type: FTP, FTPS, SFTP.

Append Date/Time Format defines the date-time format when the date-time is appended to the filename. The default date-time format is yyyy-MM-dd-HH-mm-ss-SSS and is used if this property is left blank. The format should follow the specification in SimpleDateFormat in Java, and must not contain special characters such as: {}[]<>:;$\/*?"|.

Use Temp Files

Applies to...
  • Operational Mode: Output, Out->In.
  • Connection Type: FTP, FTPS, SFTP.
  • Duplicate Filename Behaviour: Rename the file, Don't check for duplicates, Append to existing file.

Use Temp Files determines whether to use temporary files during an upload. If using temporary files is selected, the upload uses a .tmp extension on the generated filename, and then performs a rename once the upload has completed.

This option is not available if the Append date and time to filename is selected.

Property Option
Description
Do not use temporary files Rhapsody simply uploads the file with its given name.
Use .tmp files

Rhapsody first uploads the file with a temporary name, then performs a rename on the file when the upload is completed.

† Default option.