Phidiax Tech Blog

Adventures in custom software and technology implementation.

BizTalk Server 2020 (up to CU3) and BizTalk Server 2016 (up to CU9) : Auto-Install Script for SFTP Requirement of WinSCP

BizTalk WinSCP Installer

Background

January 17th, 2022: Updates to fix a few issues with BizTalk Server 2020 (as noted in the comments).

Determining which WinSCP version to install depends on your current version of Microsoft BizTalk Server 2016 or 2020 you havewhich Cumulative Update and Feature Pack/Update you have installed. Making sure that you have the right version has been historically difficult. This script detects the version of the the most recent Cumulative Update and Feature Pack and then downloads NuGet; gets the right version of WinSCP using NuGet; and then finally copies WinSCP tothe Microsoft BizTalk Server installation folder. The user must have write access to the Microsoft BizTalk Serverinstallation folder and the temporary folder used duringthe process, which implies should be running underan administrative PowerShell session. By default, the user's TEMP folderis used, and a subfolder 'nuget'is created below that and used to store the temporary files. 

NOTE: This script does not delete the temporary folder after use.

If the correct version of WinSCP is already installed in the BizTalk directory, then the script detects the installation and does nothing.

  • -WhatIf shows what would happen but makes no changes to the system.
  • -Confirm will ask for executing any step that changes the system
  • -ForceInstall overrides the WinSCP detection, downloads and installs even if the correct WinSCP version is installed.
  • -Verbose prints out extra information to help troubleshoot issues.
  • -Debug launches the ISE Debugger to allow debugging of the script.
  • Get-Help .\Script.ps1 prints out helpful information.

PRODUCTION USE

This script is designed to be used in a production environment when the system does not have access to the internet. During testing you will run this script on a system that has the same version and cumulative update versions as production. Specify the output folder using the -nugetDownloadFolder. Copy the output folder to production and run the script with the -nugetDownloadFolder setting pointing to the folder.

The script will detect that the folder contains NuGet and WinSCP in the folder and will not attempt to go to the internet to download WinSCP. Instead, the script will use the existing files and copy them to the Microsoft BizTalk Server installation folder. 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.

Credits to Michael Stepensen who created the original script.
Credits to Nicolas Blatter for testing each new release of the cumulative updates.
Credits to Sandro Pereira for updating the script and helping improve it.

Thanks for all the feedback, I was able to improve the script due to the support.

Solution

<#
.SYNOPSIS
    Version 7
        Addeup support vor Verbose flag to debug issues

    Installs WinSCP by detecting the version of Microsoft BizTalk Server 2016 or 2020
    Determines which cumulative update is installed
    Downloads WinSCP using NuGet and installs WinSCP to
    the Microsoft BizTalk Server installation folder.

    Credits to Michael Stepensen who created the original script.
    Credits to Nicolas Blatter for testing each new release of the cumulative updates.
    Credits to Sandro Pereira for updating the script and helping improve it.

    Supported versions of BizTalk Server and cumulative updates:
    Microsoft BizTalk Server 2016
        CU/FU name Build version  KB number  Release date       WinSCP Version
        CU9 FP3    3.13.357.2     5005480    September 29, 2021 WinSCP 5.19.2
        CU9        3.12.896.2     5005479    August 25, 2021    WinSCP 5.19.2
        CU8 FP3    3.13.349.2     4590075    January 6, 2021    WinSCP 5.15.9
        CU8        3.12.880.2     4583530    December 7, 2020   WinSCP 5.15.9
        CU7 FP3    3.13.340.2     4536185    January 22, 2020   WinSCP 5.15.9
        CU7        3.12.859.2     4528776    January 22, 2020   WinSCP 5.15.9
        CU6 FP3    3.12.843.2     4294900    February 7, 2019   WinSCP 5.13.1
        CU6        3.12.843.2     4477494    February 28, 2019  WinSCP 5.13.1
        CU5 FP3    3.13.324.2     4103503    June 25, 2018      WinSCP 5.13.1
        CU5 Hotfix 3.12.834.2     4132957    November 14, 2018  WinSCP 5.13.1
        CU5        3.12.834.2     4132957    June 25, 2018      WinSCP 5.13.1
        CU4 FP2    3.13.252.2     4094130    April 2, 2018       WinSCP 5.7.7
        CU4        3.12.823.2     4051353    January 30, 2018    WinSCP 5.7.7
        CU3 FP2    3.13.247.2     4054819    November 21, 2017   WinSCP 5.7.7
        CU3 FU1    3.13.177.2     4014788    November 15, 2017   WinSCP 5.7.7
        CU3        3.12.815.2     4039664    September 01, 2017  WinSCP 5.7.7
        CU2        3.12.807.2     4021095    May 26, 2017        WinSCP 5.7.7
        CU1        3.12.796.2     3208238    January 26, 2017    WinSCP 5.7.7
        RTM        3.12.774.2                December 1, 2016    WinSCP 5.7.7

    Microsoft BizTalk Server 2020
        CU name Build version KB number  Release day       WinSCP Version
        CU3     3.13.812.0    5007969    November 22, 2021 WinSCP 5.19.2
        CU2     3.13.785.0    5003151    April 19, 2021    WinSCP 5.17.6
        CU1     3.13.759.0    4538666    July 28, 2020     WinSCP 5.17.6
        RTM     3.13.717.0    NA         January 15, 2020  WinSCP 5.15.4

.DESCRIPTION
    Determining which WinSCP version to install depends on your current version of
    Microsoft BizTalk Server 2016 or 2020 you have 
    which Cumulative Update and Feature Pack/Update you have installed.
    Making sure that you have the right version has been historically difficult.
    This script detects the version of the the most recent Cumulative Update
    and Feature Pack and then downloads NuGet; gets the right version of WinSCP
    using NuGet; and then finally copies WinSCP to 
    the Microsoft BizTalk Server installation folder.
    The user must have write access to the Microsoft BizTalk Server 
    installation folder and the temporary folder used during 
    the process, which implies should be running under 
    an administrative PowerShell session.
    By default, the user's TEMP folder  is used, and a subfolder 'nuget' 
    is created below that and used to store the temporary files.
    
    NOTE: This script does not delete the temporary folder after use.

    If the correct version of WinSCP is already installed in the BizTalk
    directory, then the script detects the installation and does nothing.

    This script supports the -WhatIf parameter to show what 
    would happen but makes no changes to the system.
    
    This script supports a -ForceInstall parameter that overrides the
    WinSCP detection and installs even if the correct WinSCP version
    is installed.

    PRODUCTION USE
    This script is designed to be used in a production environment
    when the system does not have access to the internet.
    During testing you will run this script on a system that has
    the same version and cumulative update versions as production.
    Specify the output folder using the -nugetDownloadFolder.
    
    Copy the output folder to production and run the script with
    the -nugetDownloadFolder setting pointing to the folder.
    
    The script will detect that the folder contains NuGet and WinSCP
    in the folder and will not attempt to go to the internet
    to download WinSCP.
    Instead, the script will use the existing files and copy them to
    the Microsoft BizTalk Server installation folder.

.PARAMETER nugetDownloadFolder
    nugetDownloadFolder is the temporary folder that will be used 
    to save the NuGet program and the WinSCP components 
    during download.
    This folder is not deleted after the script finishes.
.PARAMETER ForceInstall
    ForceInstall is used to indicate that even if the existing 
    version of WinSCP is correct in the Microsoft BizTalk Server 
    installation folder it forces the install from the web.
.PARAMETER WhatIf
    WhatIf will show you what version of Microsoft BizTalk Server is installed.
    Then the script will show you what version of WinSCP would install.
    No changes are made to the system.
.EXAMPLE
    .\InstallWinSCPForBizTalk.ps1
    This is the fully automated installation which will install
    WinSCP based on the installed version of 
    Microsoft BizTalk Server, Cumulative Update and Feature Pack.
    If needed, it will download NuGet and WinSCP to install it.
    If the current version of WinSCP is installed it will do nothing.
.EXAMPLE
    .\InstallWinSCPForBizTalk.ps1 -nugetDownloadFolder WinSCPTemp
    This will install WinSCP using WinSCPTemp as the 
    temporary folder to store the files dowloaded.
.EXAMPLE
    .\InstallWinSCPForBizTalk.ps1 -ForceInstall
    This will install WinSCP even if the existing version of WinSCP is correct.
.NOTES
    Author: Thomas Canter, Sandro Pereira, Michael Stepensen
    Date:   December 13th, 2021
#>
[cmdletbinding(SupportsShouldProcess)]
#Parameters
Param(
    [Parameter(
        Mandatory = $false
    )]
    [ValidateNotNullOrEmpty()]
    [string]$nugetDownloadFolder = (Get-Item Env:TEMP).Value + "\nuget",
    [Parameter(
        Mandatory = $false
    )]
    [switch]$ForceInstall
)
#####################################################################
# Function to serach for specific Microsoft BizTalk Server Cumulative updates
#####################################################################
function Search-BTSCumulativeUpdate {
    Param(
        [string] $CumulativeUpdateID,
        [string] $BizTalkVersion
    )
    
    $CUFound = $false
    $CUNameTemplate = "*BizTalk *" + $BizTalkVersion + "*KB*" + $CumulativeUpdateID + "*";
    $CUFound = [bool](Get-ChildItem -path HKLM:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\ -Recurse -ErrorAction SilentlyContinue | Where-Object { $_.Name -like $CUNameTemplate });
    return $CUFound
}
#####################################################################
# Function to write an error
#####################################################################
function Write-Error {
    Param([string] $ErrorMessage)
    Write-Success -ForegroundColor Red "$ErrorMessage";
}
#####################################################################
# Function to write success
#####################################################################
function Write-Success {
    Param([string] $SuccessMessage)
    Write-Host -ForegroundColor Green "$SuccessMessage";
}
# Default $Continue flag to true, set to false to end the process
$Continue = $true;

$DebugPreference = "Continue";
$winSCPVersion = "5.7.7"
$winSCPexeFile = "WinSCP.exe";
$winSCPdllFile = "WinSCPnet.dll";
$WinSCPexe = "WinSCP.$winSCPVersion\content\$winSCPexeFile"
$winSCPdll = "WinSCP.$winSCPVersion\lib\$winSCPdllFile"
$hashString = "##############################################################################";
$bangString = "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!";
$upString = "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^";
##############################################################
# Checking for BizTalk Server
##############################################################
$bizTalkInstallFolder = (Get-Item Env:BTSINSTALLPATH).Value;
$bizTalkInstallFolderExists = Test-Path $bizTalkInstallFolder
$BizTalk2016ProductCode = '{B084F3A7-3E8F-4E7B-B673-EED1715D28ED}';
$BizTalk2020ProductCode = '{205F5836-7512-4A06-9E74-ADC8AFA0EEC5}';
$bizTalkProductCodeCurrent = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductCodeCurrent')
$bizTalkProductName = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductName')
$bizTalkProductVersion = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductVersion')
if ($Continue) {
    Write-Success $hashString
    Write-Success 'Checking if Microsoft BizTalk Server is installed.';
    Write-Success $hashString
    if (-not $bizTalkInstallFolder) {
        Write-Error ('The Env:BTSINSTALLPATH doesn`t exist, checking to see if the path is in the registry HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0@InstallPath'); 
        $bizTalkInstallFolder = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'InstallPath')
        
        if (-not $bizTalkInstallFolder) {
            $Continue = false;
            Write-Error "Microsoft BizTalk Server was not located by checking the environment variable BTSINSTALLPATH and the Registry key for BizTalk, exiting the process";
            Write-Error "Please confirm that Microsoft BizTalk Server is installed on this system";
        }
    }
    if ($Continue -and -not $bizTalkInstallFolderExists) {
        $Continue = $false
        Write-Error "$bangString"
        Write-Error "Microsoft BizTalk Server installation was found in the registry.";
        Write-Error "Regardless, the $bizTalkInstallFolder folder does not exist.";
        Write-Error "Although it was found in the registry and/or the BTSINSTALLPATH environment setting";
        Write-Error "Exiting...";
        Write-Error "$bangString"
    }
    else {
        Write-Success "Located $bizTalkProductName version $bizTalkProductVersion.";
        Write-Success "Microsoft BizTalk Server is installed.";
        Write-Success "Located in the `'$bizTalkInstallFolder`' folder.";
        if ($bizTalkProductCodeCurrent -eq $BizTalk2020ProductCode) {
            $BizTalkVersion = "2020";
        }
        elseif ($bizTalkProductCodeCurrent -eq $BizTalk2016ProductCode) {
            $BizTalkVersion = "2016";
        }
        else {
            $Continue = $false;
            Write-Error "`n$bangString"
            Write-Error "Neither Microsoft BizTalk Server 2016 nor Microsoft BizTalk Server 2020 were found."
            Write-Error "Exiting";
            Write-Error "$bangString"
        }

    }
}
Write-Verbose  "The result of the search for the BizTalk Server:";
Write-Verbose "`$bizTalkInstallFolder       $bizTalkInstallFolder";
Write-Verbose "`$bizTalkInstallFolderExists $bizTalkInstallFolderExists";
Write-Verbose "`$BizTalk2016ProductCode     $BizTalk2016ProductCode";
Write-Verbose "`$BizTalk2020ProductCode     $BizTalk2020ProductCode";
Write-Verbose "`$bizTalkProductCodeCurrent  $bizTalkProductCodeCurrent";
Write-Verbose "`$bizTalkProductName         $bizTalkProductName";
Write-Verbose "`$bizTalkProductVersion      $bizTalkProductVersion";

$winSCPVersion = $null;
$btsKB = "none";
$bizTalkCUVer = "no CU";
$CUFound = $false;
if ($Continue) {
    Write-Success "`n$hashString"
    Write-Success "Determining what version of WinSCP to download"
    Write-Success "$hashString"
    ##############################################################
    # Deciding which is the correct version of WinSCP according
    # to Microsoft BizTalk Server version and cumulative update installed
    ##############################################################
    Write-Success "Detected Microsoft BizTalk Server $BizTalkVersion.";
    Write-Success "Testing to see which Cumulative Update is installed";
    if ($BizTalkVersion -eq "2020") {
        $winSCPVersion = "5.15.4"
        # Microsoft BizTalk Server 2020
        #CU name Build version KB number Release day       WinSCP Version
        #CU3     3.13.812.0    5007969    November 22, 2021 WinSCP 5.19.2
        #CU2     3.13.785.0    5003151    April 19, 2021    WinSCP 5.17.6
        #CU1     3.13.759.0    4538666    July 28, 2020     WinSCP 5.17.6
        #NonUC   3.13.717.0    NA         January 15, 2020  WinSCP 5.15.4
        $bts2020_CU3 = "5007969";
        $bts2020_CU2 = "5003151";
        $bts2020_CU1 = "4538666";
        if (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2020_CU3 -BizTalkVersion $BizTalkVersion) {
            # Microsoft BizTalk Server 2020 CU3
            $bizTalkCUVer = 'CU3'
            $btsKB = $bts2020_CU3
            $winSCPVersion = "5.19.2"
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2020_CU2 -BizTalkVersion $BizTalkVersion) {
            # Microsoft BizTalk Server 2020 CU2
            $bizTalkCUVer = 'CU2'
            $btsKB = $bts2020_CU2
            $winSCPVersion = "5.17.6"
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2020_CU1 -BizTalkVersion $BizTalkVersion) {
            # Microsoft BizTalk Server 2020 CU1
            $bizTalkCUVer = 'CU1'
            $btsKB = $bts2020_CU1
            $winSCPVersion = "5.17.6"
            $CUFound = $true
        }
    }
    elseif ($BizTalkVersion -eq "2016") {
        # Microsoft BizTalk Server 2016
        #CU name Build version  KB number  Release date       WinSCP Version
        $bts2016_CU9_FP3 = "5005480"; #CU9 FP3    3.13.357.2     5005480    September 29, 2021 WinSCP 5.19.2
        $bts2016_CU9 = "5005479"; #CU9        3.12.896.2     5005479    August 25, 2021    WinSCP 5.19.2
        $bts2016_CU8_FP3 = "4590075"; #CU8 FP3    3.13.349.2     4590075    January 6, 2021    WinSCP 5.15.9
        $bts2016_CU8 = "4583530"; #CU8        3.12.880.2     4583530    December 7, 2020   WinSCP 5.15.9
        $bts2016_CU7_FP3 = "4536185"; #CU7 FP3    3.13.340.2     4536185    January 22, 2020   WinSCP 5.15.9
        $bts2016_CU7 = "4528776"; #CU7        3.12.859.2     4528776    January 22, 2020   WinSCP 5.15.9
        $bts2016_CU6_FP3 = "4294900"; #CU6 FP3    3.12.843.2     4294900    February 7, 2019   WinSCP 5.13.1
        $bts2016_CU6 = "4477494"; #CU6        3.12.843.2     4477494    February 28, 2019  WinSCP 5.13.1
        $bts2016_CU5_FP3 = "4103503"; #CU5 FP3    3.13.324.2     4103503    June 25, 2018      WinSCP 5.13.1
        $bts2016_CU5Hotfix = "4345385"; #CU5 Hotfix 3.12.834.2     4132957    November 14, 2018  WinSCP 5.13.1
        $bts2016_CU5 = "4132957"; #CU5        3.12.834.2     4132957    June 25, 2018      WinSCP 5.13.1
        $bts2016_CU4_FP2 = "4094130"; #CU4 FP2    3.13.252.2     4094130    April 2, 2018       WinSCP 5.7.7
        $bts2016_CU4 = "4051353"; #CU4        3.12.823.2     4051353    January 30, 2018    WinSCP 5.7.7
        $bts2016_CU3_FP2 = "4054819"; #CU3 FP2    3.13.247.2     4054819    November 21, 2017   WinSCP 5.7.7
        $bts2016_CU3_FU1 = "4014788"; #CU3 FU1    3.13.177.2     4014788    November 15, 2017   WinSCP 5.7.7
        $bts2016_CU3 = "4039664"; #CU3        3.12.815.2     4039664    September 01, 2017  WinSCP 5.7.7
        $bts2016_CU2 = "4021095"; #CU2        3.12.807.2     4021095    May 26, 2017        WinSCP 5.7.7
        $bts2016_CU1 = "3208238"; #CU1        3.12.796.2     3208238    January 26, 2017    WinSCP 5.7.7
        #NonCU      3.12.774.0     NA         September 30, 2016  WinSCP 5.7.7
        $CUfound = $false
        if (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU9_FP3 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU9 and FP3 with new WinSCP Version
            $winSCPVersion = "5.19.2"
            $btsKB = $bts2016_CU9_FP3
            $bizTalkCUVer = 'CU9 and FP3'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU9 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU9 with new WinSCP Version
            $winSCPVersion = "5.19.2"
            $btsKB = $bts2016_CU9
            $bizTalkCUVer = 'CU9'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU8_FP3 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU8 and FP3 with new WinSCP Version
            $winSCPVersion = "5.15.9"
            $btsKB = $bts2016_CU8_FP3
            $bizTalkCUVer = 'CU8 and FP3'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU8 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU8 with new WinSCP Version
            $winSCPVersion = "5.15.9"
            $btsKB = $bts2016_CU8
            $bizTalkCUVer = 'CU8'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU7_FP3 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU7 and FP3 with new WinSCP Version
            $winSCPVersion = "5.15.9"
            $btsKB = $bts2016_CU7_FP3
            $bizTalkCUVer = 'CU7 and FP3'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU7 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU7 with new WinSCP Version
            $winSCPVersion = "5.15.9"
            $btsKB = $bts2016_CU7
            $bizTalkCUVer = 'CU7'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU6_FP3 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU6 and FP 3 with new WinSCP Version
            $winSCPVersion = "5.13.1"
            $btsKB = $bts2016_CU6_FP3
            $bizTalkCUVer = 'CU6 and FP3'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU6 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU6 with new WinSCP Version
            $winSCPVersion = "5.13.1"
            $btsKB = $bts2016_CU6
            $bizTalkCUVer = 'CU6'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU5_FP3 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU5 and FP3 with new WinSCP Version
            $winSCPVersion = "5.13.1"
            $btsKB = $bts2016_CU5_FP3
            $bizTalkCUVer = 'CU5 and FP3'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU5Hotfix -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU5 Hotfix with new WinSCP Version
            $winSCPVersion = "5.13.1"
            $btsKB = $bts2016_CU5HotFix
            $bizTalkCUVer = 'CU5 Hotfix'
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU5 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU5 with new WinSCP Version
            $winSCPVersion = "5.13.1"
            $btsKB = $bts2016_CU5
            $bizTalkCUVer = 'CU5'
            $CUFound = $true
        }
        # The remainder of the CU/FU combinations use the default WinSCP Version 5.7.7
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU4_FP2 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU4 and FP2, using original WinSCP Version
            $bizTalkCUVer = 'CU4 and FP2'
            $btsKB = $bts2016_CU4_FP2
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU4 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU4, using original WinSCP Version
            $bizTalkCUVer = 'CU4'
            $btsKB = $bts2016_CU4
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU3_FP2 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU3 and FP2, using original WinSCP Version
            $bizTalkCUVer = 'CU3 and FP2'
            $btsKB = $bts2016_CU3_FP2
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU3_FU1 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU3 and FU1, using original WinSCP Version
            $bizTalkCUVer = 'CU3 and FU1'
            $btsKB = $bts2016_CU3_FU1
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU3 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU3, using original WinSCP Version
            $bizTalkCUVer = 'CU3'
            $btsKB = $bts2016_CU3
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU2 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU2, using original WinSCP Version
            $bizTalkCUVer = 'CU2 or FU1'
            $btsKB = $bts2016_CU2
            $CUFound = $true
        }
        elseif (Search-BTSCumulativeUpdate -CumulativeUpdateID $bts2016_CU1 -BizTalkVersion $BizTalkVersion) {
            # running Microsoft BizTalk Server 2016 CU1, using original WinSCP Version
            $bizTalkCUVer = 'CU1'
            $btsKB = $bts2016_CU1
            $CUFound = $true
        }
    }
    if ($CUFound) {
        Write-Success "Detected Microsoft BizTalk Server $BizTalkVersion $bizTalkCUVer KB$btsKB";
    }
    else {
        # running Microsoft BizTalk Server without any Cumulative Updates, using original WinSCP Version
        Write-Success "Detected Microsoft BizTalk Server $BizTalkVersion with no cumulative updates.";
    }
    Write-Success "If necessary, this script will download WinSCP $winSCPVersion";
}
Write-Verbose  "The result of the search for the BizTalk Cumulative Update:";
Write-Verbose "`$winSCPVersion = $winSCPVersion";
Write-Verbose "`$btsKB         = $btsKB";
Write-Verbose "`$bizTalkCUVer  = $bizTalkCUVer";
Write-Verbose "`$CUFound       = $CUFound";

$btsWinSCPEXEProductVersionInstalled = "None";
$btsWinSCPDLLProductVersionInstalled = "None";
$btsWinSCPProductInstalledAndCorrect = $false;
$winSCPProductVersionRequired = $winSCPVersion;
$btsTargetWinSCPExe = $bizTalkInstallFolder + $winSCPexeFile;
$btsTargetWinSCPDll = $bizTalkInstallFolder + $winSCPdllFile;
if ($Continue) {
    Write-Success "`n$hashString"
    Write-Success "Checking to see if WinSCP $winSCPVersion is already";
    Write-Success "installed in the Microsoft BizTalk Server folder.";
    if ((Test-Path $btsTargetWinSCPExe) -and (Test-Path $btsTargetWinSCPDll)) {
        $btsWinSCPEXEProductVersionInstalled = (get-item $btsTargetWinSCPExe).VersionInfo.ProductVersion;
        $btsWinSCPDLLProductVersionInstalled = (get-item $btsTargetWinSCPDll).VersionInfo.ProductVersion;
        $winSCPProductVersionRequired = $winSCPVersion;
        if ($winSCPVersion.length -gt 2 -and $btsWinSCPEXEProductVersionInstalled.length -gt 2 -and $winSCPVersion.SubString($winSCPVersion.length - 2, 2) -ne '.0' -and $btsWinSCPEXEProductVersionInstalled.SubString($btsWinSCPEXEProductVersionInstalled.length - 2, 2) -eq '.0') {
            $winSCPProductVersionRequired = $winSCPVersion + '.0';
        }
        if ($winSCPProductVersionRequired -eq $btsWinSCPEXEProductVersionInstalled -and $winSCPProductVersionRequired -eq $btsWinSCPDLLProductVersionInstalled) {
            $btsWinSCPProductInstalledAndCorrect = $true;
        }
    }
    if ($btsWinSCPProductInstalledAndCorrect) {
        Write-Success "Detected WinSCP $winSCPVersion is already installed in Microsoft BizTalk Server.";
        if ($ForceInstall -and $btsWinSCPProductInstalledAndCorrect) {
            Write-Success "Reinstalling because ForceInstall was specified.";
        }
        else {
            Write-Success "Skipping installing the already installed version.";
            $Continue = $false;
        }
    }
    else {
        Write-Success "$bangstring"
        Write-Success "WinSCP $winSCPVersion is NOT installed in the";
        Write-Success "Microsoft BizTalk Server folder and needs to be installed.";
    }
    Write-Success "$hashString"
}
Write-Verbose "Check for existing WinSCP results were:";
Write-Verbose "`$btsWinSCPEXEProductVersionInstalled $btsWinSCPEXEProductVersionInstalled";
Write-Verbose "`$btsWinSCPDLLProductVersionInstalled $btsWinSCPDLLProductVersionInstalled";
Write-Verbose "`$winSCPProductVersionRequired        $winSCPProductVersionRequired";
Write-Verbose "`$btsWinSCPProductInstalledAndCorrect $btsWinSCPProductInstalledAndCorrect";
Write-Verbose "`$btsTargetWinSCPExe                  $btsTargetWinSCPExe";
Write-Verbose "`$btsTargetWinSCPDll                  $btsTargetWinSCPDll";


if ($Continue) {
    $winSCPVersionArray = $winSCPVersion.Split('.');
    if ($winSCPVersionArray.Count -gt 1) {
        [int]$winSCPMajorVer = $winSCPVersionArray[0];
        [int]$winSCPMinorVer = $winSCPVersionArray[1];
    }
    else {
        $Continue = $false;
        Write-Error "WinSCP Version $winSCPVersion is not a recogized version such as 5.7.7.";
        Write-Error $bangString;
    }
    if ($winSCPMajorVer -ne 5) {
        $Continue = $false;
        Write-Error "WinSCP Version $winSCPVersion is not a supported version, only version 5.x.x is supported.";
        Write-Error $bangString;
    }
}
if ($Continue) {
    #use the right version of WinSCP
    #The WinSCP directory structure has changed over time

    #WinSCP file locations for each major version:
    #5.7.0\content\WinSCP.exe
    #5.7.0\lib\WinSCPnet.dll
    #5.9.0\content\WinSCP.exe
    #5.9.0\lib\WinSCPnet.dll
    #5.11.0\content\WinSCPnet.dll
    #5.11.0\lib\WinSCP.exe
    #5.13.0\lib\net\WinSCPnet.dll
    #5.13.0\\tools\WinSCP.exe
    #5.15.0\lib\netstandard\WinSCPnet.dll
    #5.15.0\tools\WinSCP.exe
    #5.17.0\lib\netstandard2.0\WinSCPnet.dll
    #5.17.0\tools\WinSCP.exe
    #5.19.0\lib\netstandard2.0\WinSCPnet.dll
    #5.19.0\tools\WinSCP.exe

    if ($winSCPMinorVer -eq 17 -or $winSCPMinorVer -eq 19) {
        $winSCPexe = "WinSCP.$winSCPVersion\tools\$winSCPexeFile"
        $winSCPdll = "WinSCP.$winSCPVersion\lib\netstandard2.0\$winSCPdllFile"
    }
    elseif ($winSCPMinorVer -eq 15) {
        $winSCPexe = "WinSCP.$winSCPVersion\tools\$winSCPexeFile"
        $winSCPdll = "WinSCP.$winSCPVersion\lib\netstandard\$winSCPdllFile"
    }
    elseif ($winSCPMinorVer -eq 13) {
        $winSCPexe = "WinSCP.$winSCPVersion\tools\$winSCPexeFile"
        $winSCPdll = "WinSCP.$winSCPVersion\lib\net\$winSCPdllFile"
    }
    elseif ($winSCPVersion -le 11) {
        $WinSCPexe = "WinSCP.$winSCPVersion\content\$winSCPexeFile"
        $winSCPdll = "WinSCP.$winSCPVersion\lib\$winSCPdllFile"
    }
    
    $WinSCPEXEDownload = "$nugetDownloadFolder\$winSCPexe"
    $WinSCPDllDownload = "$nugetDownloadFolder\$winSCPdll"
    $WinSCPEXEDownloadAlreadyExists = Test-Path $WinSCPexe;
    $WinSCPDllDownloadAlreadyExists = Test-Path $$WinSCPDllDownload;
    $nugetDownloadFolderAlreadyExists = Test-Path $nugetDownloadFolder;
    $nugetDownloadFolderExists = $nugetDownloadFolderAlreadyExists;
    Write-Success "`n$hashString"
    Write-Success "Preparing the output folder to store the Nuget and WinSCP downloads"
    Write-Success "$hashString"
    if ($Continue -and -not $nugetDownloadFolderAlreadyExists -and -not $btsWinSCPProductInstalledAndCorrect) {
        ##############################################################
        # Prepare output folder
        ##############################################################
        if ($PSCmdlet.ShouldProcess("$nugetDownloadFolder", "Create Folder")) {
            Write-Success ("The target folder `'$nugetDownloadFolder`' doesn't exist, creating the folder.");
            New-Item -Path $nugetDownloadFolder -ItemType "Directory" > $null
            $nugetDownloadFolderExists = Test-Path $nugetDownloadFolder
            if (-not $nugetDownloadFolderExists) {
                $Continue = $false
                Write-Error "An attempt to use the '" $nugetDownloadFolder "' directory for a download target failed.";
            }
        }
    }
    if ($Continue -and $nugetDownloadFolderExists) {
        Write-Success ("The target folder `'$nugetDownloadFolder`' is ready for use.");
    }
    Write-Verbose "Check and then potential creation of the target folder results:";
    Write-Verbose "`$nugetDownloadFolderAlreadyExists $nugetDownloadFolderExists";
    Write-Verbose "`$nugetDownloadFolderExists        $nugetDownloadFolderExists";
    Write-Verbose "`$WinSCPEXEDownload                $WinSCPEXEDownload";
    Write-Verbose "`$WinSCPDllDownload                $WinSCPDllDownload";
    Write-Verbose "`$WinSCPEXEDownloadAlreadyExists   $WinSCPEXEDownloadAlreadyExists";
    Write-Verbose "`$WinSCPDllDownloadAlreadyExists   $WinSCPDllDownloadAlreadyExists";
}
$targetNugetExe = "$nugetDownloadFolder\nuget.exe"
$targetNugetExeAlreadyExists = Test-Path $targetNugetExe
$targetNugetExeExists = $targetNugetExeAlreadyExists
if ($Continue) {
    ##############################################################
    # Download NuGet
    ##############################################################
    $sourceNugetExe = "https://dist.nuget.org/win-x86-commandline/latest/nuget.exe";
    if (-not $targetNugetExeAlreadyExists -or $ForceInstall) {
        Write-Success "`n$hashString";
        Write-Success "Downloading Nuget from:"
        Write-Success "`t`'$sourceNugetExe`'"
        Write-Success "Storing it in the folder";
        Write-Success "`t`'$nugetDownloadFolder`'"
        [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
        if ($PSCmdlet.ShouldProcess("$sourceNugetExe -OutFile $targetNugetExe", "Run Invoke-WebRequest ")) {
            Invoke-WebRequest $sourceNugetExe -OutFile $targetNugetExe
            $targetNugetExeExists = Test-Path $targetNugetExe
            if (-not $targetNugetExeExists) {
                $Continue = $false
                Write-Error "`n$bangString";
                Write-Error "The download of the Nuget EXE from";
                Write-Error $sourceNugetExe;
                Write-Error "did not succeed";
                Write-Error "$bangString";
            }
        }
    }
    else {
        Write-Success "`n$hashString";
        Write-Success "NuGet already exists in the folder";
        Write-Success $nugetDownloadFolder;
        Write-Success "and doesn't need to be downloaded";
        Write-Success "$hashString";
    }
}
Write-Verbose "Check and then potential download NuGet results:";
Write-Verbose "`$targetNugetExeAlreadyExists $targetNugetExeAlreadyExists";
Write-Verbose "`$targetNugetExeExists        $targetNugetExeExists";
Write-Verbose "`$sourceNugetExe              $sourceNugetExe";
Write-Verbose "`$targetNugetExe              $targetNugetExe";

if ($Continue) {
    $WinSCPEXEAlreadyExists = Test-Path $WinSCPEXEDownload
    $WinSCPDLLAlreadyExists = Test-Path $WinSCPDllDownload
    $WinSCPEXEExists = Test-Path $WinSCPEXEDownload
    $WinSCPDLLExists = Test-Path $WinSCPDllDownload
    $getWinSCP = "'$targetNugetExe' Install WinSCP -Version $winSCPVersion -NonInteractive -OutputDirectory '$nugetDownloadFolder'"
    Write-Success "`n$hashString";
    Write-Success "Downloading WinSCP version $winSCPVersion from NuGet";
    Write-Success "`t$getWinSCP";
    Write-Success "Storing it in the folder:"
    Write-Success "`t`'$nugetDownloadFolder`'";
    Write-Success "$hashString";
    if (-not $WinSCPEXEAlreadyExists -or -not $WinSCPDLLAlreadyExists) {
        if ($PSCmdlet.ShouldProcess("$getWinSCP", "Run Command")) {
            Invoke-Expression "& $getWinSCP";
            $WinSCPEXEExists = Test-Path $WinSCPEXEDownload
            $WinSCPDLLExists = Test-Path $WinSCPDllDownload
            if (-not $WinSCPEXEExists -or -not $WinSCPDLLExists) {
                $Continue = $false
                Write-Error "`n$bangString";
                Write-Error "WinSCP $winSCPVersion was not properly downloaded.";
                Write-Error "Check the folder and error messages above:";
                Write-Error "$nugetDownloadFolder";
                Write-Error "And determine what files did download or did not download.";
                Write-Error "$bangString";
            }
        }
    }
}
Write-Verbose "Check and then potential download WinSCP results:";
Write-Verbose "`$getWinSCP              $getWinSCP";
Write-Verbose "`$WinSCPEXEAlreadyExists $WinSCPEXEAlreadyExists";
Write-Verbose "`$WinSCPDLLAlreadyExists $WinSCPDLLAlreadyExists";
Write-Verbose "`$WinSCPDllDownload      $WinSCPDllDownload";
Write-Verbose "`$WinSCPEXEExists        $WinSCPEXEExists";
Write-Verbose "`$WinSCPDLLExists        $WinSCPDLLExists";

##############################################################
# Installing WinSCP to Microsoft BizTalk Server Folder
##############################################################
$WinSCPTargetEXEExists = Test-Path $btsTargetWinSCPExe
$WinSCPDLLTargetExists = Test-Path $btsTargetWinSCPDll
if ($Continue -and -not $btsWinSCPProductInstalledAndCorrect) {
    Write-Success "`n$hashString";
    Write-Success "Installing WinSCP";
    Write-Success "$hashString";
    #Copy WinSCP items to Microsoft BizTalk Server Folder
    Write-Success "Copying WinSCP version $winSCPVersion to Microsoft BizTalk Server Folder:";
    Write-Success "`t`'$bizTalkInstallFolder'`.";
    if ($PSCmdlet.ShouldProcess("$WinSCPexe and $WinSCPdll to `'$bizTalkInstallFolder`'", "Copy Files")) {
        Copy-Item $WinSCPEXEDownload $bizTalkInstallFolder
        Copy-Item $WinSCPDllDownload $bizTalkInstallFolder
        $WinSCPTargetEXEExists = Test-Path $btsTargetWinSCPExe
        $WinSCPDLLTargetExists = Test-Path $btsTargetWinSCPDll
        if ($WinSCPTargetEXEExists -and $WinSCPDLLTargetExists) {
            $btsWinSCPProductInstalledAndCorrect = $true;
        }
        else {
            $Continue = $false
            if (-not $WinSCPTargetEXEExists) {
                Write-Error "The $winSCPexeFile file version $winSCPVersion";
                Write-Error "It was not properly copied to the target folder `'$bizTalkInstallFolder`'.";
            }
            if (-not $WinSCPDLLTargetExists) {
                $Continue = $false
                Write-Error "The $winSCPdllFile file version $winSCPVersion";
                Write-Error "Was not properly copied to the target folder `'$bizTalkInstallFolder`'.";
            }    
        }
    }
}
Write-Verbose "Check and then potential copy WinSCP to BizTalk results:";
Write-Verbose "`$bizTalkInstallFolder                $bizTalkInstallFolder";
Write-Verbose "`$WinSCPEXEDownload                   $WinSCPEXEDownload";
Write-Verbose "`$WinSCPDllDownload                   $WinSCPDllDownload";
Write-Verbose "`$WinSCPTargetEXEExists               $WinSCPTargetEXEExists";
Write-Verbose "`$WinSCPDLLTargetExists               $WinSCPDLLTargetExists";
Write-Verbose "`$btsWinSCPProductInstalledAndCorrect $btsWinSCPProductInstalledAndCorrect";

    
if ($btsWinSCPProductInstalledAndCorrect) {
    Write-Success "`n$bangString";
    Write-Success "WinSCP $winSCPVersion is installed.";
    Write-Success "Microsoft BizTalk Server`'s SFTP Adapter will use this version of WinSCP.";
    Write-Success "$upString";
}
elseif (-not $WhatIfPreference) {
    Write-Error "`n$bangString";
    Write-Error "Something went wrong during installation and the installation did not work.";
    Write-Error "Please inspect the errors above and resolve them.";
    Write-Error "Exiting...";
    Write-Error "$bangString";
}
elseif ($WhatIfPreference) {
    Write-Success "`n$bangString";
    Write-Success "The parameter -WhatIf was set and this script executed without making";
    Write-Success "any changes and the output should checked to determine if it would have ";
    Write-Success "run correctly.";
    Write-Success "$bangString";
}

Comments (8) -

  • Iwe Kardum

    1/24/2019 1:40:38 AM | Reply

    Wonderful script! Works perfectly!

  • Peter

    5/21/2020 10:28:28 PM | Reply

    Script is bugged. The if block
        if (-not $CUFound) {
          # running BizTalk Server 2016 without any Cumulative Updates, using original WinSCP Version
          $winSCPVersion = "5.7.7"
          Write-Host "Detected BizTalk Server 2016 with no cumulative updates installed, and this download process will use WinSCP $winSCPVersion"
        }

    should be inside the Biztalk 2016 detection block, otherwise with 2020 installed it will  execute this block after detecting 2020 and install 5.7.7, the version for biztalk 2016 with no CU installed

  • MarkW

    12/8/2020 4:43:19 AM | Reply

    Thanks for this script it had helped a lot in trying to figure out why SFTP wasn't working on BizTalk.  The Microsoft documentation seems to miss this crucial requirement for WinSCP to work.

    I did run into an issue with the script running on a machine with Powershell 5.1.  The Invoke-WebRequest line to download NuGet's latest version was failing with an error:

    "Invoke-WebRequest : The request was aborted: Could not create SSL/TLS secure channel"

    I found reference to https://dist.nuget.org not accepting TFS1.0 requests and adding the following line before the web request forces TLS1.2 to be used and all worked great!  

    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

    Thanks again.

  • aQ0jhQuZthFga

    12/12/2020 2:44:40 PM | Reply

    277636 874734I came across this great from you out of sheer luck and never believe lucky enough to say also credit you for any job nicely done. 595310

  • Gert Vloo

    2/17/2021 1:48:31 AM | Reply

    Hai Thomas,

    there is a new CU released, CU8. I updated the script so it works with that one as wel.
    Cheers
    Geronius
    Motion10

    #Parameters
    Param([Parameter(Mandatory = $false)][string]$nugetDownloadFolder = (Get-Item Env:TEMP).Value + "\nuget")
    Write-Debug ('$nugetDownloadFolder :' + $nugetDownloadFolder)
    $Continue = $true
    function SearchForCU {
        # Parameter help description
        Param([string] $CumulativeUpdateID)
        Write-Debug "Checking for CU $CumulativeUpdateID"
        $CUFound = $false
        $CUNameTemplate = "*BizTalk Server 2016 *KB*$CumulativeUpdateID*"
        Write-Debug "Cumulative Update Template $CUNameTemplate"
        
        $SearchResult = Get-ChildItem -path HKLM:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\ -Recurse -ErrorAction SilentlyContinue | Where-Object { $_.Name -like $CUNameTemplate }
        if ($SearchResult) {
            Write-Host "Found BizTalk Cumulative Update " SearchResult.GetValue("DisplayName")
            $CUFound = $true
        }
        return $CUFound
    }
    $consoleWidth = $Host.UI.RawUI.WindowSize.Width - 2
    $upString = "^" * $consoleWidth
    $hashString = "#" * $consoleWidth
    $bangString = "!" * $consoleWidth
    $equalString = "=" * $consoleWidth

    Write-Host $equalString

    $nugetDownloadFolderExists = Test-Path $nugetDownloadFolder
    if (-not $nugetDownloadFolderExists) {
        Write-Host $hashString
        Write-Debug ('The $nugetDownloadFolder doesn`t exist, creating the folder ' + $nugetDownloadFolder)
        New-Item -Path $nugetDownloadFolder -ItemType "Directory"
    }
    $nugetDownloadFolderExists = Test-Path $nugetDownloadFolder
    if (-not $nugetDownloadFolderExists) {
        $Continue = $false
        Write-Error $bangString
        Write-Error "An attempt to use the '" $nugetDownloadFolder "' directory for a download target failed."
    }
    if ($Continue) {
        $bizTalkInstallFolder = (Get-Item Env:BTSINSTALLPATH).Value
        if (-not $bizTalkInstallFolder) {
            Write-Debug ('The Env:BTSINSTALLPATH doesn`t exist, checking to see if the path is in the registry HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0@InstallPath')
            $bizTalkInstallFolder = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'InstallPath')
            if (-not $bizTalkInstallFolder) {
                Write-Error $bangString
                Write-Error "BizTalk was not located by checking the environment variable BTSINSTALLPATH and"
                Write-Error " the Registry key for BizTalk, exiting the process"
                Write-Error "Confirm that BizTalk is installed"
                Write-Error $upString
                Write-Error $bangString
            }
        }
        $bizTalkInstallFolderExists = Test-Path $bizTalkInstallFolder
        if ($Continue -and -not $bizTalkInstallFolderExists) {
            $Continue = $false
            Write-Error "The BizTalk Installation was found in the registry"
            Write-Error " The folder $bizTalkInstallFolder does not exist, "
            Write-Error " even though it was discovered in the registry or the BTSINSTALLPATH environment setting"
            Write-Error $upString
            Write-Error $bangString
        }
    }
    if ($Continue) {
        $bizTalkProductCode = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductCodeCurrent')
        $bizTalkProductName = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductName')
        $bizTalkProductVer = (get-itemPropertyValue 'HKLM:\SOFTWARE\Microsoft\BizTalk Server\3.0' -Name 'ProductVersion')
        Write-Host $hashString
        Write-Host "Located $bizTalkProductName and verion $bizTalkProductVer"
        Write-Host "  installed in $bizTalkInstallFolder"
        Write-Host $hashString
        $winSCPVersion = "5.7.7"
        if ($bizTalkProductCode -eq '{205F5836-7512-4A06-9E74-ADC8AFA0EEC5}') {
            # BizTalk Server 2020
            #CU name Build version  KB number Release day       WinSCP Version
            #NonUC   3.13.717.0    NA         January 15, 2020  WinSCP 5.15.4
            Write-Host $hashString
            $winSCPVersion = "5.15.4"
            Write-Host "Detected BizTalk Server 2020 and this download process will use WinSCP $winSCPVersion"
        }
        elseif ($bizTalkProductCode -eq '{B084F3A7-3E8F-4E7B-B673-EED1715D28ED}') {
            Write-Host $hashString
            Write-Host "Detected BizTalk Server 2016, testing to see which Cumulative Update is installed"
            Write-Host $hashString
            # BizTalk Server 2016
            #
            #CU name Build version  KB number Release day       WinSCP Version
            #CU8     3.13.349.2    4590075   January 6, 2021    WinSCP 5.17.8
            #CU7     3.12.859.2    4528776   January 22, 2020   WinSCP 5.15.9
            #CU6     3.12.843.2    4477494   February 28, 2019  WinSCP 5.13.1
            #CU5     3.12.834.2    4132957   June 25, 2018      WinSCP 5.13.1
            #CU4     3.12.823.2    4051353   January 30, 2018   WinSCP 5.7.7
            #CU3     3.12.815.2    4039664   September 01, 2017 WinSCP 5.7.7
            #CU2     3.12.807.2    4021095   May 26, 2017       WinSCP 5.7.7
            #CU1     3.12.796.2    3208238   January 26, 2017   WinSCP 5.7.7
            #NonCU   3.12.xxx.x    NA        October 11, 2016   WinSCP 5.7.7
            $CUfound = $false
            Write-Host $hashString
            if (SearchForCU("4590075")) {
                # running BizTalk Server 2016 CU8 and FP 3 with new WinSCP Version
                $winSCPVersion = "5.17.8"
                Write-Host "Detected BizTalk Server 2016 with CU8 and FP3 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }        
            elseif (SearchForCU("4583530")) {
                # running BizTalk Server 2016 CU8 with new WinSCP Version
                $winSCPVersion = "5.17.8"
                Write-Host "Detected BizTalk Server 2016 with CU8 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4536185")) {
                # running BizTalk Server 2016 CU7 and FP 3 with new WinSCP Version
                $winSCPVersion = "5.15.9"
                Write-Host "Detected BizTalk Server 2016 with CU7 and FP3 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4528776")) {
                # running BizTalk Server 2016 CU7 with new WinSCP Version
                $winSCPVersion = "5.15.9"
                Write-Host "Detected BizTalk Server 2016 with CU7 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4294900")) {
                # running BizTalk Server 2016 CU6 and FP 3 with new WinSCP Version
                $winSCPVersion = "5.13.1"
                Write-Host "Detected BizTalk Server 2016 with CU6 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4477494")) {
                # running BizTalk Server 2016 CU6 with new WinSCP Version
                $winSCPVersion = "5.13.1"
                Write-Host "Detected BizTalk Server 2016 with CU6 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4132957")) {
                # running BizTalk Server 2016 CU5 with new WinSCP Version
                $winSCPVersion = "5.13.1"
                Write-Host "Detected BizTalk Server 2016 with CU5 and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4051353")) {
                # running BizTalk Server 2016 CU4, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU4, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4094130")) {
                # running BizTalk Server 2016 CU4, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU4, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4039664")) {
                4536185
                # running BizTalk Server 2016 CU3, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU3, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4054819")) {
                4536185
                # running BizTalk Server 2016 CU3, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU3, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4014788")) {
                4536185
                # running BizTalk Server 2016 CU3, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU3, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("4021095")) {
                # running BizTalk Server 2016 CU2, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU2, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("3208238")) {
                # running BizTalk Server 2016 CU1, using original WinSCP Version
                $winSCPVersion = "5.7.7"
                Write-Host "Detected BizTalk Server 2016 with CU1, and this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
                    
        }
        if (-not $CUFound) {
            # running BizTalk Server 2016 without any Cumulative Updates, using original WinSCP Version
            $winSCPVersion = "5.7.7"
            Write-Host "Detected BizTalk Server 2016 with no cumulative updates installed, and this download process will use WinSCP $winSCPVersion"
        }
        if ($winSCPVersion -eq "5.17.8") {
            $winSCPexe = "WinSCP.5.17.8\tools\WinSCP.exe"
            $winSCPdll = "WinSCP.5.17.8\lib\net40\WinSCPnet.dll"
        }
        elseif ($winSCPVersion -eq "5.15.9") {
            $winSCPexe = "WinSCP.5.15.9\tools\WinSCP.exe"
            $winSCPdll = "WinSCP.5.15.9\lib\net\WinSCPnet.dll"
        }
        elseif ($winSCPVersion -eq "5.15.4") {
            $winSCPexe = "WinSCP.5.15.4\tools\WinSCP.exe"
            $winSCPdll = "WinSCP.5.15.4\lib\net\WinSCPnet.dll"
        }
        elseif ($winSCPVersion -eq "5.13.1") {
            $winSCPexe = "WinSCP.5.13.1\tools\WinSCP.exe"
            $winSCPdll = "WinSCP.5.13.1\lib\net\WinSCPnet.dll"
        }
        elseif ($winSCPVersion -eq "5.7.7") {
            $WinSCPexe = "WinSCP.5.7.7\content\WinSCP.exe"
            $winSCPdll = "WinSCP.5.7.7\lib\WinSCPnet.dll"
        }
    }

    if ($Continue) {
        #Download NuGet
        $sourceNugetExe = "dist.nuget.org/.../nuget.exe";
        Write-Host $hashString
        Write-Host "Downloading Nuget from $sourceNugetExe and storing it in the folder $nugetDownloadFolder"
        $targetNugetExe = "$nugetDownloadFolder\nuget.exe"
        Write-Debug "Invoke-WebRequest $sourceNugetExe -OutFile $targetNugetExe"
        Invoke-WebRequest $sourceNugetExe -OutFile $targetNugetExe
        $targetNugetExeExists = Test-Path $targetNugetExe
        if (-not $targetNugetExeExists) {
            $Continue = $false
            Write-Error "The download of the Nuget EXE from " $sourceNugetExe " did not succeed"
            Write-Error $bangString
        }
    }
    if ($Continue) {
        #Download the right version of WinSCP
        Write-Host $hashString
        Write-Host "Downloading WinSCP version $winSCPVersion from NuGet $sourceNugetExe and storing it in $nugetDownloadFolder"
        Write-Debug "$getWinSCP = '$targetNugetExe' Install WinSCP -Version $winSCPVersion -OutputDirectory '$nugetDownloadFolder'"
        $getWinSCP = "'$targetNugetExe' Install WinSCP -Version $winSCPVersion -OutputDirectory '$nugetDownloadFolder'"
          
        Write-Debug "Invoke-Expression `"& $getWinSCP"
        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-Error "WinSCP $winSCPVersion was not properly downloaded"
            Write-Error $bangString
        }
    }
    if ($Continue) {
        #Copy WinSCP items to BizTalk Folder
        Write-Host $hashString
        Write-Host "Copying WinSCP version $winSCPVersion to BizTalk Folder"
        write-debug "Copy-Item $WinSCPDownload $bizTalkInstallFolder"
        Copy-Item $WinSCPDownload $bizTalkInstallFolder
        write-debug "Copy-Item $WinSCPDllDownload $bizTalkInstallFolder"
        Copy-Item $WinSCPDllDownload $bizTalkInstallFolder
        $WinSCPBTSExists = Test-Path "$bizTalkInstallFolder\WinSCP.exe"
        $WinSCPDLLBTSExists = Test-Path "$biztalkInstallFolder\WinSCPnet.dll"
        if (-not $WinSCPBTSExists) {
            $Continue = $false
            Write-Error "The WinSCP.exe file version $winSCPVersion was not properly copied to the target folder " $bizTalkInstallFolder
            Write-Error $bangString
        }
        if (-not $WinSCPDLLBTSExists) {
            $Continue = $false
            Write-Error "The WinSCPnet.dll file version $winSCPVersion was not properly copied to the target folder " $bizTalkInstallFolder
            Write-Error $bangString
        }
    }
      
    if (-not $Continue) {
        Write-Error $bangString
        Write-Error "Something went wrong during installation and the installation is not working"
        Write-Error "Please inspect the errors above and resolve them"
        Write-Error "Exiting"
        Write-Error $bangString
    }
    else {
        Write-Host $hashString
        Write-Host -ForegroundColor Green "WinSCP has been properly installed for BizTalk's SFTP Adapter"
        Write-Host -ForegroundColor Green $upString
        Write-Host $equalString
    }

  • Antony

    3/3/2021 12:08:30 AM | Reply

    Could you update your script for BizTalk Server 2016 including CU8?

  • Kadj

    12/16/2021 1:28:35 AM | Reply

    Updated skript for cu9 with below snippets. Searched fo KB number for CU8 with FP3 but gave up after not finding it easily.
            if (SearchForCU("5005480")) {
                # running BizTalk Server 2016 CU9 and FP3 with new WinSCP Version
                $winSCPVersion = "5.19.2"
                Write-Host "Detected BizTalk Server 2016 with CU9 and FP3 this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }
            elseif (SearchForCU("5005479")) {
                # running BizTalk Server 2016 CU9 with new WinSCP Version
                $winSCPVersion = "5.19.2"
                Write-Host "Detected BizTalk Server 2016 with CU9 this download process will use WinSCP $winSCPVersion"
                $CUFound = $true
            }

        if ($winSCPVersion -eq "5.19.2") {
            $winSCPexe = "WinSCP.5.19.2\tools\WinSCP.exe"
            $winSCPdll = "WinSCP.5.19.2\lib\netstandard2.0\WinSCPnet.dll"
        }
        elseif ($winSCPVersion -eq "5.17.6") {

  • Stefan

    1/11/2022 6:39:15 AM | Reply

    Maybe it's just our installation, but the script wouldn't recognize the correct FP with CU without this line changed:
    from:
    $CUNameTemplate = "*BizTalk " + $BizTalkVersion + " *KB*" + $CumulativeUpdateID + "*";
    to:
    $CUNameTemplate = "*BizTalk*" + $BizTalkVersion + " *KB*" + $CumulativeUpdateID + "*";

Loading

Privacy Policy  |  Contact  |  Careers

2009-2017 Phidiax, LLC - All Rights Reserved