Show-InstallationProgress Clarification

//Show-InstallationProgress Clarification
Show-InstallationProgress Clarification 2015-08-21T01:30:13+00:00

The Toolkit Forums Deployment Scripts Show-InstallationProgress Clarification

  • Author
    Posts
  • yralexandre
    Participant
    Post count: 8
    #535 |

    I’ve been experimenting with Show-InstallationProgress in an effort to give the user more indication that the installation is in progress particularly when experiencing delays between the display of dialogues.

    For example I strategically place the following in certain areas of the script in an effort to mitigate moments of perceived inactivity.

    Show-InstallationProgress -StatusMessage "Performing system analysis, please wait..."

    I also added “Close-InstallationProgress” (taken from the AppDeployToolkitMain.ps1) in an effort to terminate the line above so as not to interrupt the natural progression of subsequent dialogues. However, in my experience the presentation of the custom Show-InstallationProgress is often delayed significantly. Furthermore, the custom Show-InstallationProgress completely ignores the “Close-InstallationProgress” function call.

    Thanks,

    Yves

  • Muhammad Mashwani
    Keymaster
    Post count: 118

    This forum is meant for finished deployment scripts you wish to share with the community. Your question is better posted under the “General” forum.

    Can you share the full script that you are executing so I can see how the calls are being made? Perhaps I need to look at re-engineering how the function loads new messages.

    • yralexandre
      Participant
      Post count: 8

      I apologize for posting to the wrong forum. I’m willing to repost to the General forum if you’d prefer or feel free to move it if possible. The script is below.

      ######################### Start #########################
      <#
      .SYNOPSIS
      This script performs the installation or uninstallation of an application(s).
      .DESCRIPTION
      The script is provided as a template to perform an install or uninstall of an application(s).
      The script either performs an “Install” deployment type or an “Uninstall” deployment type.
      The install deployment type is broken down into 3 main sections/phases: Pre-Install, Install, and Post-Install.
      The script dot-sources the AppDeployToolkitMain.ps1 script which contains the logic and functions required to install or uninstall an application.
      .PARAMETER DeploymentType
      The type of deployment to perform. Default is: Install.
      .PARAMETER DeployMode
      Specifies whether the installation should be run in Interactive, Silent, or NonInteractive mode. Default is: Interactive. Options: Interactive = Shows dialogs, Silent = No dialogs, NonInteractive = Very silent, i.e. no blocking apps. NonInteractive mode is automatically set if it is detected that the process is not user interactive.
      .PARAMETER AllowRebootPassThru
      Allows the 3010 return code (requires restart) to be passed back to the parent process (e.g. SCCM) if detected from an installation. If 3010 is passed back to SCCM, a reboot prompt will be triggered.
      .PARAMETER TerminalServerMode
      Changes to “user install mode” and back to “user execute mode” for installing/uninstalling applications for Remote Destkop Session Hosts/Citrix servers.
      .PARAMETER DisableLogging
      Disables logging to file for the script. Default is: $false.
      .EXAMPLE
      Deploy-Application.ps1
      .EXAMPLE
      Deploy-Application.ps1 -DeployMode ‘Silent’
      .EXAMPLE
      Deploy-Application.ps1 -AllowRebootPassThru -AllowDefer
      .EXAMPLE
      Deploy-Application.ps1 -DeploymentType Uninstall
      .NOTES
      Toolkit Exit Code Ranges:
      60000 – 68999: Reserved for built-in exit codes in Deploy-Application.ps1, Deploy-Application.exe, and AppDeployToolkitMain.ps1
      69000 – 69999: Recommended for user customized exit codes in Deploy-Application.ps1
      70000 – 79999: Recommended for user customized exit codes in AppDeployToolkitExtensions.ps1
      .LINK

      The Toolkit


      .REVISION HISTORY
      Name, Date, Revision.
      Yves Alexandre, 07/16/2015, Added into the Param block for custom ToolkitExtension command line argument to handle Check-Exist by applying the argument seen in example below depending on the deployment type.

      [ValidateSet(‘Yes’,’No’)]
      [String] $CheckExist = ‘No’,
      [Parameter(Mandatory=$false)]

      .EXAMPLE
      Deploy-Application.ps1 -CheckExist “Yes|No” -DeploymentType “Uninstall”

      Yves Alexandre, 07/16/2015, Added $DisplayName and $DisplayVersion constant variable which are static predeifned values used to validate version in the Check-Exist query function.
      Yves Alexandre, 07/16/2015, Added $InstallDisplayName and $InstallDisplayVersion variables to status product install.

      $InstallDisplayName = Get-InstalledApplication -Name “<AppName>”
      $InstallDisplayVersion = (Get-InstalledApplication -Name “<AppName>”).DisplayVersion

      Yves Alexandre, 08/19/2015, Added $appInstallFile constant variable for external installer files that are subject to frequent release intervals to facilitate script maint.
      #>
      [CmdletBinding()]
      Param (
      [Parameter(Mandatory=$false)]
      [ValidateSet(‘Install’,’Uninstall’)]
      [string]$DeploymentType = ‘Install’,
      [Parameter(Mandatory=$false)]
      [ValidateSet(‘Yes’,’No’)]
      [String] $CheckExist = ‘No’,
      [Parameter(Mandatory=$false)]
      [ValidateSet(‘Interactive’,’Silent’,’NonInteractive’)]
      [string]$DeployMode = ‘Interactive’,
      [Parameter(Mandatory=$false)]
      [switch]$AllowRebootPassThru = $false,
      [Parameter(Mandatory=$false)]
      [switch]$TerminalServerMode = $false,
      [Parameter(Mandatory=$false)]
      [switch]$DisableLogging = $false
      )

      Try {
      ## Set the script execution policy for this process
      Try { Set-ExecutionPolicy -ExecutionPolicy ‘ByPass’ -Scope ‘Process’ -Force -ErrorAction ‘Stop’ } Catch {}

      ##*===============================================
      ##* VARIABLE DECLARATION
      ##*===============================================
      ## Variables: Application
      [string]$appVendor = ‘CAS00ACB’
      [string]$appName = ‘Wireshark’
      [string]$DisplayName = ‘Wireshark’
      [string]$appVersion = ‘1.12.7’
      [string]$DisplayVersion = ‘1.12.7’
      [string]$appInstallFileWin64 = ‘Wireshark-win64-‘ + $DisplayVersion + ‘.exe’
      [string]$appInstallFileWin32 = ‘Wireshark-win32-‘ + $DisplayVersion + ‘.exe’
      [string]$appArch = ”
      [string]$appLang = ”
      [string]$appRevision = ”
      [string]$appScriptVersion = ‘1.0.1508.13’
      [string]$appScriptDate = ‘2015.08.13’
      [string]$appScriptAuthor = ‘alexayr’
      ##*===============================================

      ##* Do not modify section below
      #region DoNotModify

      ## Variables: Exit Code
      [int32]$mainExitCode = 0

      ## Variables: Script
      [string]$deployAppScriptFriendlyName = ‘Deploy Application’
      [version]$deployAppScriptVersion = [version]’3.6.5′
      [string]$deployAppScriptDate = ’08/17/2015′
      [hashtable]$deployAppScriptParameters = $psBoundParameters

      ## Variables: Environment
      If (Test-Path -LiteralPath ‘variable:HostInvocation’) { $InvocationInfo = $HostInvocation } Else { $InvocationInfo = $MyInvocation }
      [string]$scriptDirectory = Split-Path -Path $InvocationInfo.MyCommand.Definition -Parent

      ## Dot source the required App Deploy Toolkit Functions
      Try {
      [string]$moduleAppDeployToolkitMain = “$scriptDirectory\AppDeployToolkit\AppDeployToolkitMain.ps1”
      If (-not (Test-Path -LiteralPath $moduleAppDeployToolkitMain -PathType ‘Leaf’)) { Throw “Module does not exist at the specified location [$moduleAppDeployToolkitMain].” }
      If ($DisableLogging) { . $moduleAppDeployToolkitMain -DisableLogging } Else { . $moduleAppDeployToolkitMain }
      }
      Catch {
      If ($mainExitCode -eq 0){ [int32]$mainExitCode = 60008 }
      Write-Error -Message “Module [$moduleAppDeployToolkitMain] failed to load: n$($_.Exception.Message)n `n$($_.InvocationInfo.PositionMessage)” -ErrorAction ‘Continue’
      ## Exit the script, returning the exit code to SCCM
      If (Test-Path -LiteralPath ‘variable:HostInvocation’) { $script:ExitCode = $mainExitCode; Exit } Else { Exit $mainExitCode }
      }

      #endregion
      ##* Do not modify section above
      ##*===============================================
      ##* END VARIABLE DECLARATION
      ##*===============================================

      If ($DeploymentType -ine ‘Uninstall’) {
      Show-InstallationProgress -StatusMessage “Performing system analysis, please wait…”
      ##*===============================================
      ##* PRE-INSTALLATION
      ##*===============================================
      [string]$installPhase = ‘Pre-Installation’

      $InstallDisplayName = Get-InstalledApplication -Name “Wireshark”
      $InstallDisplayVersion = (Get-InstalledApplication -Name “Wireshark”).DisplayVersion
      if ($CheckExist -ieq ‘Yes’) {Check-Exist}

      ## Close the Installation Progress Dialog if running
      Close-InstallationProgress
      ## Show Welcome Message, close Internet Explorer if required, allow up to 3 deferrals, verify there is enough disk space to complete the install, and persist the prompt
      Show-InstallationWelcome -CloseApps ‘wireshark,op_flse,aceanalyst’ -AllowDefer -DeferTimes 5 -CheckDiskSpace -PersistPrompt

      ## Show Progress Message (with the default message)
      Show-InstallationProgress

      ## <Perform Pre-Installation tasks here>

      ##*===============================================
      ##* INSTALLATION
      ##*===============================================
      [string]$installPhase = ‘Installation’

      ## Handle Zero-Config MSI Installations
      If ($useDefaultMsi) {
      [hashtable]$ExecuteDefaultMSISplat = @{ Action = ‘Install’; Path = $defaultMsiFile }; If ($defaultMstFile) { $ExecuteDefaultMSISplat.Add(‘Transform’, $defaultMstFile) }
      Execute-MSI @ExecuteDefaultMSISplat; If ($defaultMspFiles) { $defaultMspFiles | ForEach-Object { Execute-MSI -Action ‘Patch’ -Path $_ } }
      }

      ## <Perform Installation tasks here>
      Write-Log -Message “[Custom-logging] :: [$InstallName] :: Applying the appropriate architecture specific installation, please wait.”
      Start-Sleep -Seconds 10
      if ($is64Bit -eq $true) {
      Write-Log -Message “[Custom-logging] :: [$InstallName] :: Attempting to execute installer file(s), please wait.”
      Start-Sleep -Seconds 10
      Execute-Process -Path “$scriptDirectory\Source\$appInstallFileWin64” -Arguments “/S /desktopicon=no /quicklaunchicon=no” -WindowStyle Hidden -IgnoreExitCodes “1,2,3”
      } Else {
      Write-Log -Message “[Custom-logging] :: [$InstallName] :: Attempting to execute installer file(s), please wait.”
      Start-Sleep -Seconds 10
      Execute-Process -Path “$scriptDirectory\Source\$appInstallFileWin32” -Arguments “/S /desktopicon=no /quicklaunchicon=no” -WindowStyle Hidden -IgnoreExitCodes “1,2,3”
      }

      ##*===============================================
      ##* POST-INSTALLATION
      ##*===============================================
      [string]$installPhase = ‘Post-Installation’

      ## <Perform Post-Installation tasks here>
      Update-Prefs
      Start-Sleep -Seconds 10

      $InstallDisplayName = Get-InstalledApplication -Name “Wireshark”
      $InstallDisplayVersion = (Get-InstalledApplication -Name “Wireshark”).DisplayVersion
      ## Display a message at the end of the install
      If (-not $useDefaultMsi) {Check-InstallStatus}
      }
      ElseIf ($DeploymentType -ieq ‘Uninstall’)
      {
      Show-InstallationProgress -StatusMessage “Performing system analysis, please wait…”
      ##*===============================================
      ##* PRE-UNINSTALLATION
      ##*===============================================
      [string]$installPhase = ‘Pre-Uninstallation’

      $InstallDisplayName = Get-InstalledApplication -Name “Wireshark”
      $InstallDisplayVersion = (Get-InstalledApplication -Name “Wireshark”).DisplayVersion
      if ($CheckExist -ieq ‘Yes’) {Check-Exist}
      ## Close the Installation Progress Dialog if running
      Close-InstallationProgress
      ## Show Welcome Message, close Internet Explorer with a 60 second countdown before automatically closing
      Show-InstallationWelcome -CloseApps ‘wireshark,op_flse,aceanalyst’ -CloseAppsCountdown 60

      ## Show Progress Message (with the default message)
      Show-InstallationProgress

      ## <Perform Pre-Uninstallation tasks here>

      ##*===============================================
      ##* UNINSTALLATION
      ##*===============================================
      [string]$installPhase = ‘Uninstallation’

      ## Handle Zero-Config MSI Uninstallations
      If ($useDefaultMsi) {
      [hashtable]$ExecuteDefaultMSISplat = @{ Action = ‘Uninstall’; Path = $defaultMsiFile }; If ($defaultMstFile) { $ExecuteDefaultMSISplat.Add(‘Transform’, $defaultMstFile) }
      Execute-MSI @ExecuteDefaultMSISplat
      }

      # <Perform Uninstallation tasks here>
      if ($is64Bit -eq $true) {
      Write-Log -Message “[Custom-logging] :: [$InstallName] :: Attempting to execute uninstaller file(s), please wait.”
      Start-Sleep -Seconds 10
      Execute-Process -FilePath “$envProgramFiles\Wireshark\uninstall.exe” -Arguments “/S” -WindowStyle Hidden -IgnoreExitCodes “1,2,3”
      } Else {
      Write-Log -Message “[Custom-logging] :: [$InstallName] :: Attempting to execute uninstaller file(s), please wait.”
      Start-Sleep -Seconds 10
      Execute-Process -FilePath “$envProgramFilesX86\Wireshark\uninstall.exe” -Arguments “/S” -WindowStyle Hidden -IgnoreExitCodes “1,2,3”
      }

      #Display a message at the end of the uninstall
      $InstallDisplayName = Get-InstalledApplication -Name “Wireshark”
      $InstallDisplayVersion = (Get-InstalledApplication -Name “Wireshark”).DisplayVersion
      Check-UninstallStatus

      ##*===============================================
      ##* POST-UNINSTALLATION
      ##*===============================================
      [string]$installPhase = ‘Post-Uninstallation’

      ## <Perform Post-Uninstallation tasks here>

      }

      ##*===============================================
      ##* END SCRIPT BODY
      ##*===============================================

      ## Call the Exit-Script function to perform final cleanup operations
      Exit-Script -ExitCode $mainExitCode
      }
      Catch {
      [int32]$mainExitCode = 60001
      [string]$mainErrorMessage = “$(Resolve-Error)”
      Write-Log -Message $mainErrorMessage -Severity 3 -Source $deployAppScriptFriendlyName
      Show-DialogBox -Text $mainErrorMessage -Icon ‘Stop’
      Exit-Script -ExitCode $mainExitCode
      }

      ######################### Finish ########################

      Thanks,

      Yves

      • This reply was modified 2 years, 3 months ago by  yralexandre.
      • This reply was modified 2 years, 3 months ago by  yralexandre.
  • Muhammad Mashwani
    Keymaster
    Post count: 118

    No, it’s fine here for now. I can’t really move it. I think I will need to look at re-engineering how new messages get loaded because I keep hearing from users that messages take some time to load.

You must be logged in to reply to this topic.