Skip to Content

Parameter reference for SFTP Advanced Mode

Introduction

I must admit that I am not good at searching for solutions from SAP Notes. There are many regular contributors in this space that are really good at searching through SAP Notes (you know who you are!) and I am often amazed at the Notes that they come up with to help resolve the issues in this space.

 

Perhaps one day, one of these superheroes might come up with a blog on how to effectively search for solutions in SAP Notes Until then, the rest of us mortals are left to our own devices to navigate the wild wild west of the SAP Notes world.

 

Every now and then, I notice there will be a reference SAP Note to some parameter for the SFTP’s Advanced Mode. Personally, I find it frustrating that these parameters are not listed in the Online Help Portal for the SFTP adapter. Additionally, even SAP Note 1692819 which is the FAQ for the SFTP adapter does not provide a complete list of all the parameters available.

 

This document is my attempt to provide a central listing for all the parameters available in the SFTP adapter’s Advanced Mode. It is based on the latest SP (SP04 at time of writing) of the SFTP adapter. It is a compilation of all the parameters with their related SAP Note, and I’ve also thrown in a few undocumented ones I’ve created this as a collaborative document, so anyone who is interested to help maintain this listing (maybe for future SPs) are welcome – just drop me a comment to request for edit permission.

 

 

Parameter Reference

 

Both directions

 

Parameter Default Value SAP Note Description Example Issue
addDefaultFileExtension false

1817747

1815655

Files are archived with default .txt extension

File Extension “.txt” using SFTP-SND-Adpater

SFTP receiver channel Archive filename isssue

skipRemoteDirCheck false 1737547 Skip remote directory check on SFTP servers implementation (example GXS) that deviate from RFC

Button advanced mode not present on SFTP receiver adapter

Issue with SFTP Connectivity on PI 7.3

oscomamnd.trace false Undocumented Log OS command errors even when trace level is not set to “Debug” – similar to Note 1334947 for File Adapter

ignore.error.cd

ignore.error.ls

ignore.error.pwd

false

false

false

1859563 Ignore error with the pwd/cd/ls commands occur due to incompatibility with certain servers

Strange error with new SAP SFTP adapter “Exception received: 4: cd to … failed”

SFTP : Receiver Channel Error : Javax.resource.ResourceException: 10: pwd failed

connection.mode.permanent false 2069078 Set connection mode of SFTP channel to permanent. By default a new connection is made at each polling and/or message processing

auth.method.privatekey

privatekey.view

privatekey.entry

false

null

null

2028233 Support SFTP servers that require two-factor authentication

 

Sender

 

Parameter Default Value SAP Note Description Example Issue
receiveBufferSize 65535 1738500 File retrieve operation fails with the following error: “Inputstream is closed”. Buffer size can be changed to lesser custom value
duplicateCheckPersist

20160

(14 days)

1744700 Define custom duplicate check validity SFTP Sender CC weird Error: Duplicated Message-ID in database
usePathForLs false 1850220 Use full path when performing listing for files and additional files instead of current directory (ls .)
file.encoding UTF-8 1906648 Support different encoding for filename if code pages of PI OS and SFTP Server points to different encoding
skip.directory.check false 2238416 Skip check that restricts SFTP sender channel from polling files from directories other than the one specified in the channel

 

Receiver

 

Parameter Default Value SAP Note Description Example Issue
retain.attachment.name false Undocumented Retain filenames of attachment when using “Store attachments” in receiver channel SFTP Receiver adapter – Store attachments File name issue
8 Comments
You must be Logged on to comment or reply to a post.
  • Thanks for the exhaustive list… How did we find out about this:

    retain.attachment.name

    I found this page searching for this string that I luckily came across in another post and wanted to see what main reference I could come up with for this. Pretty important parameter.

  • Hello,

    cool! SAP added a few parameters for temporary file management (note 2374607):

    temp.file.name
    temp.file.timestamp
    temp.file.msgid

    I have a requirement to have custom extension for temporary file (not .tmp). Any way to achieve that? I wanted to use UDF but is it possible to set additional parameter from UDF?

    BR,

    Denis

  • 2742386 – SFTP: File getting corrupted when chunk transfer interrupted
    https://launchpad.support.sap.com/#/notes/0002742386
    additional parameter: checkChunkInterrupted = true

    2638660 – Support for ZLIB compression in sftp adapter
    https://launchpad.support.sap.com/#/notes/0002638660
    additional parameter: enableZlibCompression = true

    2628910 – Support for Multiple Fingerprints in SFTP adapter
    https://launchpad.support.sap.com/#/notes/0002628910
    use the “~” operator to separate the fingerprints

    2069078 – SFTP Adapter Connection Mode Permanent
    https://launchpad.support.sap.com/#/notes/2069078
    additional parameter: connection.mode.permanent = true

    2544233 – Support for non UTF-8 and special characters in SFTP Adapter (sender channel)
    https://launchpad.support.sap.com/#/notes/0002544233
    additional parameter: encodingFormat
    default encoding used is UTF-8.
    Eg: encodingFormat = ISO-8859-1

    1906648 – SFTP Adapter: File names with Umlaut characters
    https://launchpad.support.sap.com/#/notes/0001906648
    additional parameter: file.encoding
    Eg: file.encoding = ISO-8859-1

     

    2374607 – SFTP Adapter messages fail with error when use temporary file option is used
    https://launchpad.support.sap.com/#/notes/2374607
    advanced mode parameters has been introduced:
    temp.file.name
    temp.file.timestamp
    temp.file.msgid

    temp.file.name : If the parameter “temp.file.name” is set to some value, then the temporary filename will be created according to the configured filename scheme. The default value for the parameter “temp.file.name” is ‘tempfile.tmp’ which means, if this parameter is configured in the advanced mode table without any value, then the temporary filename will be ‘tempfile.tmp’.

    temp.file.timestamp: If the parameter “temp.file.timestamp” is set with value ‘true’ along with the parameter “temp.file.name”, then the tempfile will be created by appending the timestamp to configured filename scheme.

    temp.file.msgid: If the parameter “temp.file.msgid” is set with value ‘true’ along with the parameter “temp.file.name”, then the tempfile will be created by appending the message id to configured filename scheme.

     

     

    I tried note 2374607 but in sftadapter version 1000.1.0.5.25.20190122105500 it doesn’t work.

    You also expect to be able to set 

    temp.file.msgid = true

    temp.file.name = workdir/..tmp

    this should result in a tempfile being created in subdirectory workdir of the target dir with messageid added to the filename. (works for file/ftp adapter)

    I created ticket to SAP yesterday.

     

    It’s a pitty SAP has decided to implement the parameters as advanced mode parameters on receiver channel. ASMA implementation would have allowed to set the parameters dynamically at runtime and this would be a much better approach.

     

    setting 

    temp.file.name = temp.tmp

    doesn’t work either

    • Other findings of sftp adapter

      skipRemoteDirCheck doesn’t skip the check, what’s the purpose of this parameter?

      skip.directory.check doesn’t skip the check, what’s the purpose of this parameter?

      I tried uploading to zOS/MVS system but it doesn’t work even though it is a trivial upload.

      You expect an enterprise class sftp adapter to be able to handle a simple

      put <sourcefile> <targetfile>

      but sap po sftp adapter can’t handle the simple task, after more than 1 year of processing sap support hasn’t fixed the problem.

      The following paramters seem to have no effect. What’s the purpose of them?

      ignore.error.cd

      ignore.error.ls

      ignore.error.pwd