Files
PS_AppDeploy-Scripts/Q-Pulse to QMS Migration/1.0/Invoke-AppDeployToolkit.ps1

365 lines
13 KiB
PowerShell

<#
.SYNOPSIS
PSAppDeployToolkit - This script performs the installation or uninstallation of an application(s).
.DESCRIPTION
- The script is provided as a template to perform an install, uninstall, or repair of an application(s).
- The script either performs an "Install", "Uninstall", or "Repair" deployment type.
- The install deployment type is broken down into 3 main sections/phases: Pre-Install, Install, and Post-Install.
The script imports the PSAppDeployToolkit module which contains the logic and functions required to install or uninstall an application.
PSAppDeployToolkit is licensed under the GNU LGPLv3 License - (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
.PARAMETER DeploymentType
The type of deployment to perform.
.PARAMETER DeployMode
Specifies whether the installation should be run in Interactive (shows dialogs), Silent (no dialogs), or NonInteractive (dialogs without prompts) mode.
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 Desktop Session Hosts/Citrix servers.
.PARAMETER DisableLogging
Disables logging to file for the script.
.EXAMPLE
powershell.exe -File Invoke-AppDeployToolkit.ps1 -DeployMode Silent
.EXAMPLE
powershell.exe -File Invoke-AppDeployToolkit.ps1 -AllowRebootPassThru
.EXAMPLE
powershell.exe -File Invoke-AppDeployToolkit.ps1 -DeploymentType Uninstall
.EXAMPLE
Invoke-AppDeployToolkit.exe -DeploymentType "Install" -DeployMode "Silent"
.INPUTS
None. You cannot pipe objects to this script.
.OUTPUTS
None. This script does not generate any output.
.NOTES
Toolkit Exit Code Ranges:
- 60000 - 68999: Reserved for built-in exit codes in Invoke-AppDeployToolkit.ps1, and Invoke-AppDeployToolkit.exe
- 69000 - 69999: Recommended for user customized exit codes in Invoke-AppDeployToolkit.ps1
- 70000 - 79999: Recommended for user customized exit codes in PSAppDeployToolkit.Extensions module.
.LINK
https://psappdeploytoolkit.com
#>
[CmdletBinding()]
param
(
[Parameter(Mandatory = $false)]
[ValidateSet('Install', 'Uninstall', 'Repair')]
[PSDefaultValue(Help = 'Install', Value = 'Install')]
[System.String]$DeploymentType,
[Parameter(Mandatory = $false)]
[ValidateSet('Interactive', 'Silent', 'NonInteractive')]
[PSDefaultValue(Help = 'Interactive', Value = 'Interactive')]
[System.String]$DeployMode,
[Parameter(Mandatory = $false)]
[System.Management.Automation.SwitchParameter]$AllowRebootPassThru = $false,
[Parameter(Mandatory = $false)]
[System.Management.Automation.SwitchParameter]$TerminalServerMode = $false,
[Parameter(Mandatory = $false)]
[System.Management.Automation.SwitchParameter]$DisableLogging
)
##================================================
## MARK: Variables
##================================================
$adtSession = @{
# App variables.
AppVendor = 'Ideagen'
AppName = 'Ideagen Quality Management'
AppVersion = '7.7.0.0'
AppArch = 'x64'
AppLang = 'EN'
AppRevision = '01'
AppSuccessExitCodes = @(0)
AppRebootExitCodes = @(1641, 3010)
AppScriptVersion = '1.1.1'
AppScriptDate = '08/08/2025'
AppScriptAuthor = 'jxp066admin'
# Install Titles (Only set here to override defaults set by the toolkit).
InstallName = ''
InstallTitle = ''
# Script variables.
DeployAppScriptFriendlyName = $MyInvocation.MyCommand.Name
DeployAppScriptVersion = '4.0.6'
DeployAppScriptParameters = $PSBoundParameters
}
function Install-ADTDeployment
{
##================================================
## MARK: Pre-Install
##================================================
$adtSession.InstallPhase = "Pre-$($adtSession.DeploymentType)"
# Define the BPC Q-Pulse 7.1 Shortcut locations for removal.
$StartMenu = "$profile\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Gael Ltd\BPC Q-Pulse 7.1.appref-ms"
$UserDesktop = "$profile\Desktop\BPC Q-Pulse 7.1.appref-ms"
$PublicDesktop = "C:\Users\Public\Desktop\BPC Q-Pulse 7.1.appref-ms"
if (test-path $StartMenu)
{
Write-ADTLogEntry "$profile BPC Q-Pulse Public Desktop shortcut found"
Remove-ADTFile -Path $StartMenu -Recurse
Write-ADTLogEntry "$profile BPC Q-Pulse Start Menu shorcut deleted."
}
if (test-path $UserDesktop)
{
Write-ADTLogEntry "$profile BPC Q-Pulse User Desktop shortcut found."
Remove-ADTFile -Path $UserDesktop -Recurse
Write-ADTLogEntry "BPC Q-Pulse User Desktop shorcut deleted."
}
if (test-path $PublicDesktop)
{
Write-ADTLogEntry "$profile Q-Pulse Public Desktop shortcut found"
Remove-ADTFile -Path $PublicDesktop -Recurse
Write-ADTLogEntry "$profile Q-Pulse Public Desktop shorcut deleted."
}
# Remove the Hospital Q-Pulse install.
Write-ADTLogEntry "Uninstalling the Hospital Q-Pulse if it is installed."
Start-ADTMsiProcess -Action 'Uninstall' -ProductCode '{FE79B968-9408-4A7B-9862-1394A1D2CFB0}'
$HosStartMenu = "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Q-Pulse\Q-Pulse.lnk"
$HosUserDesktop = "$profile\Desktop\Q-Pulse.lnk"
$HosPublicDesktop = "C:\Users\Public\Desktop\Q-Pulse.lnk"
if (test-path $HosStartMenu)
{
Write-ADTLogEntry "Start Menu for the Hospital Q-Pulse Public Desktop shortcut found"
Remove-ADTFile -Path $HosStartMenu -Recurse
Write-ADTLogEntry "Hospital Q-Pulse Start Menu shorcut deleted."
}
if (test-path $HosUserDesktop)
{
Write-ADTLogEntry "$profile Hospital Q-Pulse User Desktop shortcut found."
Remove-ADTFile -Path $HosUserDesktop -Recurse
Write-ADTLogEntry "$profile Hospital Q-Pulse User Desktop shorcut deleted."
}
if (test-path $HosPublicDesktop)
{
Write-ADTLogEntry "Hospital Q-Pulse Public Desktop shortcut found"
Remove-ADTFile -Path $HosPublicDesktop -Recurse
Write-ADTLogEntry "Hospital Q-Pulse Public Desktop shorcut deleted."
}
##================================================
## MARK: Install
##================================================
$adtSession.InstallPhase = $adtSession.DeploymentType
# Copy over the new Click-Once Installer shortcut.
<# This All Works, but I would like to actually remove the old Click-Once so I am keeping this here just in case.
Write-ADTLogEntry "Copying over the ClickOnce installer shortcut and the Web shortcut to the Public Desktop."
Write-ADTLogEntry "Copying files over to C:\ProgramData\Ideagen QMS\"
Copy-ADTFile -Path "$($adtSession.DirFiles)\*.url" -Destination 'C:\Users\Public\Desktop'
Copy-ADTFile -Path "$($adtSession.DirFiles)\*" -Destination 'C:\ProgramData\Ideagen QMS\'
#>
# Path to your pre-created script
$UserScript = Join-Path -Path $($adtSession.DirFiles) -ChildPath "Q-Pulse_ClickOnce_Uninstall.ps1"
# Make sure there is an interactive session before running
if (Get-ADTLoggedOnUser) {
Start-ADTProcessAsUser -FilePath "powershell.exe" -ArgumentList "-NoProfile -ExecutionPolicy Bypass -File `"$UserScript`""
}
else {
Write-Log "No logged-on user detected. Skipping execution of $UserScript."
}
# Start-ADTProcessAsUser -FilePath "$($adtSession.DirFiles)\Q-Pulse_ClickOnce_Uninstall.ps1" -ArgumentList '-Execute'
##================================================
## MARK: Post-Install
##================================================
$adtSession.InstallPhase = "Post-$($adtSession.DeploymentType)"
## Master Wrapper detection
Set-ADTRegistryKey -Key "HKLM\SOFTWARE\InstalledApps\Ideagen_Ideagen Quality Management_7.7.0.0"
}
function Uninstall-ADTDeployment
{
##================================================
## MARK: Pre-Uninstall
##================================================
$adtSession.InstallPhase = "Pre-$($adtSession.DeploymentType)"
##================================================
## MARK: Uninstall
##================================================
$adtSession.InstallPhase = $adtSession.DeploymentType
# Remove the Q-Pulse shortcuts
Write-ADTLogEntry "Removing ClickOnce installer shortcut and the Web shortcut to the Public Desktop."
Write-ADTLogEntry "Removing the directory C:\ProgramData\Ideagen QMS\"
Remove-ADTFile -Path "C:\Users\Public\Desktop\Ideagen - QMS Web Shortcut.url" -Recurse
Remove-ADTFile -Path "C:\Users\Public\Desktop\Ideagen QMS ClickOnce Install.url" -Recurse
Remove-ADTFile -Path "C:\ProgramData\Ideagen QMS\" -Recurse
##================================================
## MARK: Post-Uninstallation
##================================================
$adtSession.InstallPhase = "Post-$($adtSession.DeploymentType)"
## Master Wrapper detection
Remove-ADTRegistryKey -Key "HKLM\SOFTWARE\InstalledApps\Ideagen_Ideagen Quality Management_7.7.0.0"
}
function Repair-ADTDeployment
{
##================================================
## MARK: Pre-Repair
##================================================
$adtSession.InstallPhase = "Pre-$($adtSession.DeploymentType)"
##================================================
## MARK: Repair
##================================================
$adtSession.InstallPhase = $adtSession.DeploymentType
##================================================
## MARK: Post-Repair
##================================================
$adtSession.InstallPhase = "Post-$($adtSession.DeploymentType)"
## Master Wrapper detection
Set-ADTRegistryKey -Key "HKLM\SOFTWARE\InstalledApps\Ideagen_Ideagen Quality Management_7.7.0.0"
}
##================================================
## MARK: Initialization
##================================================
# Set strict error handling across entire operation.
$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
$ProgressPreference = [System.Management.Automation.ActionPreference]::SilentlyContinue
Set-StrictMode -Version 1
# Import the module and instantiate a new session.
try
{
$moduleName = if ([System.IO.File]::Exists("$PSScriptRoot\PSAppDeployToolkit\PSAppDeployToolkit.psd1"))
{
Get-ChildItem -LiteralPath $PSScriptRoot\PSAppDeployToolkit -Recurse -File | Unblock-File -ErrorAction Ignore
"$PSScriptRoot\PSAppDeployToolkit\PSAppDeployToolkit.psd1"
}
else
{
'PSAppDeployToolkit'
}
Import-Module -FullyQualifiedName @{ ModuleName = $moduleName; Guid = '8c3c366b-8606-4576-9f2d-4051144f7ca2'; ModuleVersion = '4.0.6' } -Force
try
{
$iadtParams = Get-ADTBoundParametersAndDefaultValues -Invocation $MyInvocation
$adtSession = Open-ADTSession -SessionState $ExecutionContext.SessionState @adtSession @iadtParams -PassThru
}
catch
{
Remove-Module -Name PSAppDeployToolkit* -Force
throw
}
}
catch
{
$Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int32]::MaxValue)))
exit 60008
}
##================================================
## MARK: Invocation
##================================================
try
{
Get-Item -Path $PSScriptRoot\PSAppDeployToolkit.* | & {
process
{
Get-ChildItem -LiteralPath $_.FullName -Recurse -File | Unblock-File -ErrorAction Ignore
Import-Module -Name $_.FullName -Force
}
}
& "$($adtSession.DeploymentType)-ADTDeployment"
Close-ADTSession
}
catch
{
Write-ADTLogEntry -Message ($mainErrorMessage = Resolve-ADTErrorRecord -ErrorRecord $_) -Severity 3
Show-ADTDialogBox -Text $mainErrorMessage -Icon Stop | Out-Null
Close-ADTSession -ExitCode 60001
}
finally
{
Remove-Module -Name PSAppDeployToolkit* -Force
}