PackageDeployment Module Help

Package Deployment Module (DSM eScript Commands)

Show-ADTInstallationWelcome Cmdlet

Version 4.0.0.5

Show-ADTInstallationWelcome

Synopsis

Show a welcome dialog prompting the user with information about the installation and actions to be performed before the installation can begin.

Syntax

Show-ADTInstallationWelcome [-CloseApps <String>] [-CloseAppsCountdown <Int32>] [-Context <String>] [-DeferDays <Int32>] [-DeferDeadline <String>] [-DeferTimes <Int32>] [-ForceCloseAppsCountdown <Int32>] [-ForceCountdown <Int32>] [-MinimizeWindows <Boolean>] [-TopMost <Boolean>] [-AllowDefer] [-AllowDeferCloseApps] [-BlockExecution] [-CustomText] [-PersistPrompt] [-PromptToSave] [-Silent] [<CommonParameters>]

Show-ADTInstallationWelcome -CheckDiskSpace [-CloseApps <String>] [-CloseAppsCountdown <Int32>] [-Context <String>] [-DeferDays <Int32>] [-DeferDeadline <String>] [-DeferTimes <Int32>] [-ForceCloseAppsCountdown <Int32>] [-ForceCountdown <Int32>] [-MinimizeWindows <Boolean>] [-RequiredDiskSpace <Int32>] [-TopMost <Boolean>] [-AllowDefer] [-AllowDeferCloseApps] [-BlockExecution] [-CustomText] [-PersistPrompt] [-PromptToSave] [-Silent] [<CommonParameters>]

Description

The following prompts can be included in the welcome dialog:

  1. Close the specified running applications, or optionally close the applications without showing a prompt (using the -Silent switch).
  2. Defer the installation a certain number of times, for a certain number of days or until a deadline is reached.
  3. Countdown until applications are automatically closed.
  4. Prevent users from launching the specified applications while the installation is in progress.

Notes:

The process descriptions are retrieved from WMI, with a fall back on the process name if no description is available. Alternatively, you can specify the description yourself with a '=' symbol - see examples.

The dialog box will timeout after the timeout specified in the XML configuration file (default 1 hour and 55 minutes) to prevent SCCM installations from timing out and returning a failure code to SCCM. When the dialog times out, the script will exit and return a 1618 code (SCCM fast retry code).

Parameters

-AllowDefer <SwitchParameter>

Enables an optional defer button to allow the user to defer the installation.

Required

False

Position

Named

Accepts pipeline input

False

-AllowDeferCloseApps <SwitchParameter>

Enables an optional defer button to allow the user to defer the installation only if there are running applications that need to be closed. This parameter automatically enables -AllowDefer

Required

False

Position

Named

Accepts pipeline input

False

-BlockExecution <SwitchParameter>

Option to prevent the user from launching processes/applications, specified in -CloseApps, during the installation.

Required

False

Position

Named

Accepts pipeline input

False

-CheckDiskSpace <SwitchParameter>

Specify whether to check if there is enough disk space for the installation to proceed. If this parameter is specified without the RequiredDiskSpace parameter, the required disk space is calculated automatically based on the size of the script source and associated files.

Required

True

Position

Named

Accepts pipeline input

False

-CloseApps <String>

Name of the process to stop (do not include the .exe). Specify multiple processes separated by a comma. Specify custom descriptions like this: "winword=Microsoft Office Word,excel=Microsoft Office Excel"

Required

False

Position

Named

Accepts pipeline input

False

-CloseAppsCountdown <Int32>

Option to provide a countdown in seconds until the specified applications are automatically closed. This only takes effect if deferral is not allowed or has expired.

Required

False

Position

Named

Accepts pipeline input

False

-Context <String>

User: Execution under user account; logging in HKEY_CURRENT_USER, i.e. for the user.
UserPerService: User-related command, execution in Service context.
Computer: Execution under user account; logging in HKEY_CURRENT_MACHINE, i.e. for the computer.
ComputerPerService: Execution in service context; logging in HKEY_LOCAL_MACHINE, i.e. for the computer.

Required

False

Position

6

Accepts pipeline input

False

-CustomText <SwitchParameter>

Specify whether to display a custom message specified in the XML file. Custom message must be populated for each language section in the XML.

Required

False

Position

Named

Accepts pipeline input

False

-DeferDays <Int32>

Specify the number of days since first run that the installation can be deferred. This is converted to a deadline.

Required

False

Position

Named

Accepts pipeline input

False

-DeferDeadline <String>

Specify the deadline date until which the installation can be deferred. Specify the date in the local culture if the script is intended for that same culture. 

If the script is intended to run on EN-US machines, specify the date in the format: "08/25/2013" or "08-25-2013" or "08-25-2013 18:00:00". 

If the script is intended for multiple cultures, specify the date in the universal sortable date/time format:  "2013-08-22 11:51:52Z". 

The deadline date will be displayed to the user in the format of their culture.

Required

False

Position

Named

Accepts pipeline input

False

-DeferTimes <Int32>

Specify the number of times the installation can be deferred.

Required

False

Position

Named

Accepts pipeline input

False

-ForceCloseAppsCountdown <Int32>

Option to provide a countdown in seconds until the specified applications are automatically closed regardless of whether deferral is allowed.

Required

False

Position

Named

Accepts pipeline input

False

-ForceCountdown <Int32>

Specify a countdown to display before automatically proceeding with the installation when a deferral is enabled.

Required

False

Position

Named

Accepts pipeline input

False

-MinimizeWindows <Boolean>

Specifies whether to minimize other windows when displaying prompt. Default: $true.

Required

False

Position

Named

Accepts pipeline input

False

-PersistPrompt <SwitchParameter>

Specify whether to make the Show-InstallationWelcome prompt persist in the center of the screen every couple of seconds, specified in the AppDeployToolkitConfig.xml. The user will have no option but to respond to the prompt. This only takes effect if deferral is not allowed or has expired.

Required

False

Position

Named

Accepts pipeline input

False

-PromptToSave <SwitchParameter>

Specify whether to prompt to save working documents when the user chooses to close applications by selecting the "Close Programs" button. 

Required

False

Position

Named

Accepts pipeline input

False

-RequiredDiskSpace <Int32>

Specify required disk space in MB, used in combination with CheckDiskSpace.

Required

False

Position

Named

Accepts pipeline input

False

-Silent <SwitchParameter>

Stop processes without prompting the user.

Required

False

Position

Named

Accepts pipeline input

False

-TopMost <Boolean>

Specifies whether the windows is the topmost window. Default: $true.

Required

False

Position

Named

Accepts pipeline input

False

<CommonParameters>

For more information about common parameters, type "Get-Help about_CommonParameters".