Update sftp-adapter.md #1005
Update sftp-adapter.md #1005
Conversation
Added Transfer mode, spelling error, more information regarding polling interval and max connection reuse time.
|
Learn Build status updates of commit 13ea615:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| biztalk/core/sftp-adapter.md | View | Details |
biztalk/core/sftp-adapter.md
- Line 191, Column 456: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.varenum' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 191, Column 456: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.varenum' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
| @@ -12,7 +12,10 @@ ms.topic: "article" | |||
| BizTalk Server includes an **SFTP** adapter to send and receive messages from a secure FTP server using the SSH file transfer protocol. This topic includes the steps to configure an **SFTP** receive location, and configure an SFTP send port to receive and send messages from a secure FTP server. It also includes common questions and answers. | |||
|
|
|||
| ## Prerequisites | |||
| **Starting with BizTalk Server 2016**, the SFTP adapter uses WinSCP to connect to SFTP, and therefore supports a larger range of SFTP servers. **Download [WinSCP](http://winscp.net)** on the BizTalk Server runtime. Be sure to check the supported WinSCP versions for each BizTalk Server verison: | |||
| **Starting with BizTalk Server 2016**, the SFTP adapter uses WinSCP to connect to SFTP, and therefore supports a larger range of SFTP servers. **Download [WinSCP](http://winscp.net)** on the BizTalk Server runtime. Be sure to check the default supported WinSCP versions for each BizTalk Server version: | |||
| * BizTalk Server 2020 with CU6 - WinSCP version 6.3.3 | |||
There was a problem hiding this comment.
We can wait to release this change until CU6 is live or we can update up to CU5 which is missing and do one more change later once CU6. I am just afraid it will be forgotten again if we don't do it now.
| @@ -45,14 +48,15 @@ BizTalk Server 2013 and BizTalk Server 2013 R2 use older ssh library instead of | |||
| |--------------|----------------| | |||
| |Connection Limit|Specify the maximum number of concurrent connections that can be opened to the server.<br /><br /> This setting is per server and per receive location. Consider the following scenarios:<br /><br /> - There are two receive locations that have the same configuration property values, including the ConnectionLimit property set to the same value. For example, the property is set to 6. In this situation, there is one connection pool (with 6 available connections) that is used by both receive locations.<br /><br /> - There are two receive locations configured with same configuration values, and have the ConnectionLimit property set to different values. For example, ReceiveLocation1 property is set to 6 and ReceiveLocation2 property is set to 5. In this situation, each receive location has its own connection pool with its own available connections. ReceiveLocation1 connection pool has 6 available connections. ReceiveLocation2 connection pool has 5 available connections.| | |||
| |Log| Available starting with BizTalk Server 2016. <br/><br/>Enter the full path to create a client-side log file. Use this log file to troubleshoot any errors.| | |||
| |Maximum Connection Reuse Time In Seconds| Available starting with BizTalk Server 2016 CU 7. <br/><br/>The maximum connection reuse time allows connections to be gracefully closed and removed from the pool after a connection has been in use for a specific amount of time. A value is 0 or less indicates that this behaviour is disabled.| | |||
| |Maximum Connection Reuse Time In Seconds| Available starting with BizTalk Server 2016 CU 7. <br/><br/>The maximum connection reuse time allows connections to be gracefully closed and removed from the pool after a connection has been in use for a specific amount of time. It is recommended to set a value here, e g 240 seconds, to release temporary session files. A value is 0 or less indicates that this behaviour is disabled.| | |||
There was a problem hiding this comment.
In my opinion these are more like tips and tricks that may be useful in certain situations to some customers. I don't know if we should include this in mainline docs
There was a problem hiding this comment.
This is one of our top customer cases we get very often where customers get into thread deadlock situations and huge temp files stuck on C: drive filling disk due to our default settings being sub-optimal. I think it is good to have it visible where customers will see it. But we can move down also to later FAQ section, but afraid many will miss this.
|
|
||
| **Polling** | ||
|
|
||
| |Use this|To do this| | ||
| |--------------|----------------| | ||
| |Enable Timestamp Comparison|Available starting with BizTalk Server 2016 cumulative update 6. <br/><br/>If **Retain After Download** is set to True, this property determines whether a change in file timestamp will trigger a re-download of the file.<br /><br /> **Default value:** False| | ||
| |Polling Interval|Specify the intervals at which the adapter polls the server. To poll continuously, set this value to zero.<br /><br /> **Default value:** 5| | ||
| |Polling Interval|Specify the intervals at which the adapter polls the server. To poll continuously, set this value to zero. If you set this to a low value you may get high CPU consumption. It is recommended to set this to as high value as possible. You should also consider that the DIR listing can take long time if there are lots of files in the folder you poll. <br /><br /> **Default value:** 5| |
There was a problem hiding this comment.
Again, not sure if this belongs in mainline docs. Maybe we could have a section for common problems and suggested solutions.
There was a problem hiding this comment.
This is also one of our common customer cases we get very often where customers get into due to our default settings being sub-optimal. Sometimes with 1000 files in the folder and slow connection on busy SFTP server, only the DIR listing can take 20 seconds and when polling default value is 5 seconds, it is causing constant high CPU polling. I think it is good to have it visible where customers will see it. But we can move down also to later FAQ section, but afraid many will miss this. A good default value for SFTP receive polling in my opinion would be more 120 seconds to avoid high cpu on BizTalk and high load on SFTP servers.
| @@ -45,14 +48,15 @@ BizTalk Server 2013 and BizTalk Server 2013 R2 use older ssh library instead of | |||
| |--------------|----------------| | |||
| |Connection Limit|Specify the maximum number of concurrent connections that can be opened to the server.<br /><br /> This setting is per server and per receive location. Consider the following scenarios:<br /><br /> - There are two receive locations that have the same configuration property values, including the ConnectionLimit property set to the same value. For example, the property is set to 6. In this situation, there is one connection pool (with 6 available connections) that is used by both receive locations.<br /><br /> - There are two receive locations configured with same configuration values, and have the ConnectionLimit property set to different values. For example, ReceiveLocation1 property is set to 6 and ReceiveLocation2 property is set to 5. In this situation, each receive location has its own connection pool with its own available connections. ReceiveLocation1 connection pool has 6 available connections. ReceiveLocation2 connection pool has 5 available connections.| | |||
| |Log| Available starting with BizTalk Server 2016. <br/><br/>Enter the full path to create a client-side log file. Use this log file to troubleshoot any errors.| | |||
| |Maximum Connection Reuse Time In Seconds| Available starting with BizTalk Server 2016 CU 7. <br/><br/>The maximum connection reuse time allows connections to be gracefully closed and removed from the pool after a connection has been in use for a specific amount of time. A value is 0 or less indicates that this behaviour is disabled.| | |||
| |Maximum Connection Reuse Time In Seconds| Available starting with BizTalk Server 2016 CU 7. <br/><br/>The maximum connection reuse time allows connections to be gracefully closed and removed from the pool after a connection has been in use for a specific amount of time. It is recommended to set a value here, e g 240 seconds, to release temporary session files. A value is 0 or less indicates that this behaviour is disabled.| | |||
| |Transfer Mode| Available starting with BizTalk Server 2020 CU 3. <br/><br/>The WinSCP transfer mode. Default is binary. ASCII and Automatic can also be selected. Binary default mode is normally good for most scenarios, but in certain UNIX, mainframe text file transfer scenarios, ASCII mode may be needed for proper line end conversion.| | |||
There was a problem hiding this comment.
Same for this suggestion as well
There was a problem hiding this comment.
Transfer mode, we can shorten and we can link to WinSCP documentation page also, but that page may move or change so I thought it was better to have more details here instead. It is mainly useful for UNIX/Mainframe text file transfers.
Maximum connection reuse time is same as above comment :
This is one of our top customer cases we get very often where customers get into thread deadlock situations and huge temp files stuck on C: drive filling disk due to our default settings being sub-optimal. I think it is good to have it visible where customers will see it. But we can move down also to later FAQ section, but afraid many will miss this.
Added Transfer mode, spelling error, more information regarding polling interval and max connection reuse time.