Background

In the BizTalk installation documentation it outlines the fact that you need WinSCP. Michael Stephenson wrote a great article that goes into the how and why. He also included a simple script to automatically install the right version.

UPDATE: This script now automatically detects BizTalk Server 2020, BizTalk Server 2016 Cumulative Update 5 and the older versions of BizTalk Server 2016 before Cumulative Update 5 and downloads and installs the correct version. Thanks to Nicolas Blatter, a good friend, fellow former VTS and integration export who pointed out the change in behavior.

Solution

As I love to script, I wanted to build something that was a little more robust and flexible. Here is the extended script which tries to figure out as much as possible automatically and gives error messages that might help you track down the problem.

#Parameters
Param([Parameter(Mandatory=$true)][string]$nugetDownloadFolder)
$Continue = $true
$nugetDownloadFolderExists = Test-Path $nugetDownloadFolder
$WinSCPexe = "WinSCP.5.7.7\content\WinSCP.exe"
$WinSCPDllDownload = "WinSCP.5.7.7\lib\WinSCPnet.dll"
if (-not $nugetDownloadFolderExists)
{
    New-Item -Path $nugetDownloadFolder -ItemType "Directory"
}
$nugetDownloadFolderExists = Test-Path $nugetDownloadFolder
if (-not $nugetDownloadFolderExists)
{
    $Continue = $false
    Write-Host "An attempt to use the '" $nugetDownloadFolder "' directory for a download target failed."
}
if ($Continue)
{
    $bizTalkInstallFolder = (Get-Item Env:BTSINSTALLPATH).Value
    if (-not $bizTalkInstallFolder)
    {
        $bizTalkInstallFolder = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'InstallPath')
        if (-not $bizTalkInstallFolder)
        {
            $bizTalkInstallFolder = "C:\Program Files (x86)\Microsoft BizTalk Server 2020\\"
        }
    }
    $bizTalkInstallFolderExists = Test-Path $bizTalkInstallFolder
    if (-not $bizTalkInstallFolderExists)
    {
        $Continue = $false
        Write-Host "The BizTalk Installation was not found by inspecting the enviornment or registry."
    }

    $bizTalkProductCode = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductCodeCurrent')
    if ($bizTalkProductCode -eq '{FFF25E7A-A7F7-4B10-9B70-042A6734D806}')
    {
        # running BizTalk Server 2020
        "Detected BizTalk Server 2020 and this download process will use WinSCP 5.15.4"
        $winSCPexe = "WinSCP.5.15.4\tools\WinSCP.exe"
        $winSCPdll = "WinSCP.5.15.4\lib\net\WinSCPnet.dll"
        $winSCPVersion = "5.15.4"
    }
    elseif ($bizTalkProductCode -eq '{B084F3A7-3E8F-4E7B-B673-EED1715D28ED}')
    {
        # running BizTalk Server 2016 CU5 with new WinSCP Version
        "Detected BizTalk Server 2016 with CU5 and this download process will use WinSCP 5.13.1"
        $winSCPexe = "WinSCP.5.13.1\tools\WinSCP.exe"
        $winSCPdll = "WinSCP.5.13.1\lib\net\WinSCPnet.dll"
        $winSCPVersion = "5.13.1"
    }
    else
    {
        # running BizTalk Server 2016 before CU5 with old WinSCP Version
        "Detected BizTalk Server 2016 before CU5 and this download process will use WinSCP 5.7.7"
        $WinSCPexe = "WinSCP.5.7.7\content\WinSCP.exe"
        $WinSCPDllDownload = "WinSCP.5.7.7\lib\WinSCPnet.dll"
        $winSCPVersion = "5.7.7"
    }
}
if ($Continue)
{
    #Download NuGet
    $sourceNugetExe = "https://dist.nuget.org/win-x86-commandline/latest/nuget.exe"
    Write-Host "Downloading Nuget from " $sourceNugetExe
    $targetNugetExe = "$nugetDownloadFolder\nuget.exe"
    Invoke-WebRequest $sourceNugetExe -OutFile $targetNugetExe
    $targetNugetExeExists = Test-Path $targetNugetExe
    if (-not $targetNugetExeExists)
    {
        $Continue = $false
        Write-Host "The download of the Nuget EXE from " $sourceNugetExe " did not succeed"
    }
}
if ($Continue)
{
    #Download the right version of WinSCP
    Write-Host "Downloading WinSCP version $winSCPVersion from NuGet " $sourceNugetExe
    $getWinSCP = "'$targetNugetExe' Install WinSCP -Version $winSCPVersion -OutputDirectory '$nugetDownloadFolder'"
     
    Invoke-Expression "& $getWinSCP"
    $WinSCPDownload = "$nugetDownloadFolder\$winSCPexe"
    $WinSCPDllDownload = "$nugetDownloadFolder\$winSCPdll"
    $WinSCPExists = Test-Path $WinSCPDownload
    $WinSCPDLLExists = Test-Path $WinSCPDllDownload
    if (-not $WinSCPExists -or -not $WinSCPDLLExists)
    {
        $Continue = $false
        Write-Host "WinSCP $winSCPVersion was not properly downloaded"
    }
}
if ($Continue)
{
    #Copy WinSCP items to BizTalk Folder
    Write-Host "Copying WinSCP version $winSCPVersion to BizTalk Folder"
    Copy-Item $WinSCPDownload $bizTalkInstallFolder
    Copy-Item $WinSCPDllDownload $bizTalkInstallFolder
    $WinSCPBTSExists = Test-Path "$bizTalkInstallFolder\WinSCP.exe"
    $WinSCPDLLBTSExists = Test-Path "$biztalkInstallFolder\WinSCPnet.dll"
    if (-not $WinSCPBTSExists)
    {
        $Continue = $false
        Write-Host "The WinSCP.exe file version $winSCPVersion was not properly copied to the target folder " $bizTalkInstallFolder
    }
    if (-not $WinSCPDLLBTSExists)
    {
        $Continue = $false
        Write-Host "The WinSCPnet.dll file version $winSCPVersion was not properly copied to the target folder " $bizTalkInstallFolder
    }
}
 
if (-not $Continue)
{
    Write-Host "Something went wrong during installation and the installation is not working"
    Write-Host "Please inspect the errors above and resolve them"
}
else
{
    Write-Host "WinSCP has been properly installed for BizTalk's SFTP Adapter"
}