{"id":182,"date":"2018-08-07T22:12:00","date_gmt":"2018-08-07T21:12:00","guid":{"rendered":"http:\/\/wp.bizoir.dk\/?p=182"},"modified":"2018-08-07T22:12:00","modified_gmt":"2018-08-07T21:12:00","slug":"new-sftp-adapter-in-biztalk-2016","status":"publish","type":"post","link":"https:\/\/wp.bizoir.dk\/?p=182","title":{"rendered":"New SFTP adapter in Biztalk 2016"},"content":{"rendered":"

WCF WinSCP-based SFTP Adapter<\/h1>\n

Since Microsoft now supplies a SFTP Adapter with Biztalk Server 2016, we thought we might as well try it out instead of using the Blogical one (which we have had several problems with).<\/p>\n

It is relatively straightforward to use it in static sendports and receivelocations – the only thing we miss, is a possibility to use temporary filenames during transmission, which it does not support – only temporary folders.<\/p>\n

However, it does not seem to be documented how to use the adapter in a dynamic sendport (at least, we have been unable to find it)<\/p>\n

As documented, the SFTP Adapter uses the WinSCP program to do its actual work and specifically, it requires the WinSCPnet.dll to do its work.<\/p>\n

Microsoft have implemented the WCF adapter in this DLL which wraps the calls to WinSCP.<\/p>\n

C:\\Program Files (x86)\\Microsoft BizTalk Server 2016\\Microsoft.BizTalk.Adapter.Sftp.dll<\/span> – Assembly version 3.0.1.0<\/p>\n

The Adapter loads the WinSCPnet DLL in the class SftpHelper<\/span>.<\/p>\n

The dynamic properties can be found in the class SftpOutputChannel<\/span> Method AddPropertiesFromMessageContext<\/span>.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Context Property<\/th>\nDescription<\/th>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#ClientAuthenticationMode<\/td>\nthis.sendPropertyBag.ClientAuthenticationMode = (ClientAuthenticationMode) Enum.Parse(typeof (ClientAuthenticationMode), property.Value.ToString());<\/p>\n

enum Password, PublicKeyAuthentication, MultiFactorAuthentication<\/td>\n<\/tr>\n

http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#UserName<\/td>\nEither specify UserName and Password, or specify a keyfile in PrivateKeyFile<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#Password<\/td>\nPassword<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#PrivateKeyFile<\/td>\nFull path to Private Key<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#PrivateKeyPassword<\/td>\nPassword to the private key, if it is password protected<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#AccessAnyServerHostKey<\/td>\nIf False, host fingerprint must be specified. If True, all hosts will be accepted<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#SSHServerHostKeyFingerPrint<\/td>\nSpecify the fingerprint of SSH servers HostKey, if “AccessAnyServerHostKey” is False<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#AppendIfExists<\/td>\nIf False, transfer will fail if a file with the filename already exists. If True, the contents will be appended to the existing file<\/p>\n

We have not been able to make the “AppendIfExists” work. If this property is true, the adapter issues a get command for the filename, and if the file does not exist yet (first transfer), then the transmission fails.<\/td>\n<\/tr>\n

http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#TargetFileName<\/td>\nThe name of the file created on the SFTP server. You can use the macros specified below<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#TemporaryFolder<\/td>\nthis.sendPropertyBag.TemporaryFolder = property.Value.ToString();<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#ProxyAddress<\/td>\nAddress of a proxy-server, if you need to use one, or blank.<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#ProxyUserName<\/td>\nUsername and password for the proxy-server, or blank if they are not needed<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#ProxyPassword<\/td>\n<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#ProxyPort<\/td>\nPort for the proxy-server<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#ProxyType<\/td>\nthis.sendPropertyBag.ProxyType = (Microsoft.BizTalk.Adapter.Sftp.ProxyType) Enum.Parse(typeof (Microsoft.BizTalk.Adapter.Sftp.ProxyType), property.Value.ToString());<\/p>\n

enum None, SOCKS4, SOCKS5, HTTP<\/td>\n<\/tr>\n

http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#EncryptionCipher<\/td>\nthis.sendPropertyBag.EncryptionCipher = (EncryptionCipher) Enum.Parse(typeof (EncryptionCipher), property.Value.ToString());<\/p>\n

enum Auto, AES, Arcfour, BlowFish, TripleDES, DES<\/td>\n<\/tr>\n

http:\/\/schemas.microsoft.com\/BizTalk\/2012\/Adapter\/sftp-properties#Log<\/td>\nthis.sendPropertyBag.Log = property.Value.ToString();<\/td>\n<\/tr>\n
http:\/\/schemas.microsoft.com\/BizTalk\/2003\/system-properties#OutboundTransportLocation<\/td>\nContains the full EndPointAddress of the server – on the form sftp:\/\/servername:port<\/p>\n

this.ParseSftpUrl(property.Value.ToString());<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

OutboundTransportLocation needs to be ‘sftp’ (case insensitive compare)<\/p>\n

Supported macros<\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Macro<\/th>\nValue<\/th>\n<\/tr>\n
Use fixed context-property<\/td>\n<\/tr>\n
%MessageID%<\/td>\nhttp:\/\/schemas.microsoft.com\/BizTalk\/2003\/system-properties#BizTalkMessageID<\/td>\n<\/tr>\n
%SourceFileName%<\/td>\nhttp:\/\/schemas.microsoft.com\/BizTalk\/2003\/file-properties#ReceivedFileName<\/td>\n<\/tr>\n
Use the macro as the name of a context-property
\nUse the contextproperty with the namespace namespace http:\/\/schemas.microsoft.com\/BizTalk\/2003\/system-properties# with the macroname (nix the percent-signs) appended<\/td>\n<\/tr>\n
%DestinationParty%<\/td>\n<\/tr>\n
%DestinationPartyQualifier%<\/td>\n<\/tr>\n
%SourceParty%<\/td>\n<\/tr>\n
%SourcePartyQualifier<\/td>\n<\/tr>\n
These macros formats either DateTime.Now or DateTime.UtcNow in the specified format<\/td>\n<\/tr>\n
%datetime%<\/td>\nyyyy-MM-ddThhmmss<\/td>\n<\/tr>\n
%datetime_bts2000%<\/td>\nyyyyMMddhhmmssf<\/td>\n<\/tr>\n
%datetime.tz%<\/td>\nyyyy-MM-ddThhmmsszzz<\/td>\n<\/tr>\n
%time%<\/td>\nhhmmss<\/td>\n<\/tr>\n
%time.tz%<\/td>\nhhmmsszzz<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

WCF WinSCP-based SFTP Adapter Since Microsoft now supplies a SFTP Adapter with Biztalk Server 2016, we thought we might as well try it out instead of using the Blogical one (which we have had several problems with). It is relatively straightforward to use it in static sendports and receivelocations – the only thing we miss, … Continue reading “New SFTP adapter in Biztalk 2016”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"aside","meta":{"footnotes":""},"categories":[21],"tags":[],"class_list":["post-182","post","type-post","status-publish","format-aside","hentry","category-biztalk","post_format-post-format-aside"],"_links":{"self":[{"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=\/wp\/v2\/posts\/182","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=182"}],"version-history":[{"count":14,"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=\/wp\/v2\/posts\/182\/revisions"}],"predecessor-version":[{"id":207,"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=\/wp\/v2\/posts\/182\/revisions\/207"}],"wp:attachment":[{"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=182"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=182"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/wp.bizoir.dk\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=182"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}