Management Center MSI Custom Actions
In this section:
- MSI Custom Actions
- Management Console Custom Actions
- Management Server Custom Actions
- Client Communications Agent Custom Actions
MSI Custom Actions
There are a number of Custom Actions used within the Management Center that provide enhanced capabilities to the standard action. Each Custom Action relates to one of the following MSI’s used in the installation of the Management center:
- ManagementConsole32.msi or ManagementConsole64.msi
- ManagementServer64.msi
- ClientCommunicationAgent32.msi or ClientCommunicationAgent64.msi
Management Console Custom Actions
doGetManagementServerURL
|
Name |
doGetManagementServerURL |
|
Type |
1 – Assembly: InstallerActions, Method: GetManagementServerURL |
|
Description |
Reads the last used server from ServerSettings.xml and sets the MANAGEMENTSERVERURL msi property to the most recently used server. This is run during a GUI install to pre-populate the management server dialog with a default management server when not upgrading an old version. Reads: [%APPDATA%\AppSense\ServerSettings.xml] |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
doGetManagementServerURL
|
Name |
doGetManagementServerURL |
|
Type |
1 – Assembly: InstallerActions, Method: GetManagementServerURL |
|
Description |
Reads the last used server from ServerSettings.xml and sets the MANAGEMENTSERVERURL msi property to the most recently used server. This is run during a GUI install to pre-populate the management server dialog with a default management server when not upgrading an old version. Reads: [%APPDATA%\AppSense\ServerSettings.xml] |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
doStripServerPath
|
Name |
doStripServerPath |
|
Type |
1 – Assembly: InstallerActions, Method: StripServerPath |
|
Description |
Removes the "/ManagementServer" path from the MSI property MANAGEMENTSERVERURL. Reads property MANAGEMENTSERVERURL. Sets property MANAGEMENTSERVERURL. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
EnterServerWarning
|
Name |
EnterServerWarning |
|
Type |
4134 – Embedded VBScript |
|
Description |
Displays a message box stating “Please enter the Management Server URL” if the user forgets. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
CheckURL
|
Name |
CheckURL |
|
Type |
1 – Assembly: InstallerActions, Method: TestURL |
|
Description |
Checks whether a given URL is well-formed. Reads property MANAGEMENTSERVERURL, Sets MANAGEMENTSERVERURL to canonical version if URL is good. Set URL_OK to either “1” if good or empty string if bad URL |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
BadURL
|
Name |
BadURL |
|
Type |
4134 – Embedded VBScript |
|
Description |
Displays a message box saying “URL is invalid” if the user types a bad URL. Run if property URL_OK is empty. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
ExecuteManagementConsoleUninstall
|
Name |
ExecuteManagementConsoleUninstall |
|
Type |
210 –executable: Console.exe |
|
Description |
Invokes the console executable in silent mode to perform uninstall tasks. Deletes: [%LOCALAPPDATA%\AppSense\ManagementConsole] |
|
Occurs During |
Uninstall |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
In a script |
|
Has Rollback |
No |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
(AddServer
|
Name |
AddServer |
|
Type |
1025 –assembly: InstallerActions, Method: AddServer |
|
Description |
Adds the value in [MANAGEMENTSERVERURL] into the list of known management servers in ManagementServers.xml, creating it if needed. If a new entry is added into this file, then it is marked as new with a special tag. This tag is used to remove the entry on rollback, and removed during the commit phase. |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
deferred |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
RemoveServer
|
Name |
RemoveServer |
|
Type |
1281 –assembly: InstallerActions, Method: RemoveServer |
|
Description |
Removes [MANAGEMENTSERVERURL] from the ManagementServers.xml file if it was marked as new |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
rollback |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
RemoveMarkerTags
|
Name |
RemoveMarkerTags |
|
Type |
1537 –assembly: InstallerActions, Method: RemoveMarkerTags |
|
Description |
Removes the ‘new’ tags from the ManagementServers.xml file |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
commit |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
TurnOffGeneratePublisherEvidence
|
Name |
TurnOffGeneratePublisherEvidence |
|
Type |
1025 – assembly: InstallerActions, method TurnOffGeneratePublisherEvidence |
|
Description |
This action reads the ManagementConsole.exe.config file and ensures that the generatePublisherEvidence element exists and is set to false. This will not have any effect during a normal install as the installed file has this set. Writes to: [CONSOLEINSTALLDIR]ManagementConsole.exe.config [CONSOLEINSTALLDIR]ManagementConsole.exe.config.tmp |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
deferred |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
TurnOffGeneratePublisherEvidenceCommit
|
Name |
TurnOffGeneratePublisherEvidenceCommit |
|
Type |
1025 – assembly: InstallerActions, method TurnOffGeneratePublisherEvidenceCommit |
|
Description |
This action deletes any tmp files created by the TurnOffGeneratePublisheEvidence action Deletes: [CONSOLEINSTALLDIR]ManagementConsole.exe.config.tmp |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
commit |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
TurnOffGeneratePublisherEvidenceRollback
|
Name |
TurnOffGeneratePublisherEvidenceRollback |
|
Type |
1025 – assembly: InstallerActions, method TurnOffGeneratePublisherEvidenceRollback |
|
Description |
This action copies any tmp files made by the TurnOffGeneratePublisheEvidence action over the original files, then deletes the tmp files Writes To: [CONSOLEINSTALLDIR]ManagementConsole.exe.config Deletes: [CONSOLEINSTALLDIR]ManagementConsole.exe.config.tmp |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Rollback |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
WixFailWhenDeferred
|
Name |
WixFailWhenDeferred |
|
Type |
1025 – assembly: WixCA, method WixFailWhenDeferred |
|
Description |
Part of the WiX library. http://wix.sourceforge.net/manual-wix3/wixfailwhendeferred.htm This action simply fails the install during the deferred execution stage. Set the property WIXFAILWHENDEFERRED=1 to cause the failure. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
FolderToDelete
|
Name |
FolderToDelete |
|
Type |
1 – assembly: InstallerActions, method: |
|
Description |
This action deletes the specified directory |
|
Occurs During |
Uninstall |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
No |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
Management Server Custom Actions
WixUIValidatePath
|
Name |
WixUIValidatePath |
|
Type |
65 – 3rd party assembly: WixUIWixca, Method: ValidatePath |
|
Description |
Part of the Wix library. |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
WixUIPrintEula
|
Name |
WixUIPrintEula |
|
Type |
65 – 3rd party assembly: WixUIWixca, Method: PrintEula |
|
Description |
Part of the Wix library. |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
GetPlatform
|
Name |
GetPlatform |
|
Type |
1 –assembly: InstallerActions, Method: GetPlatform |
|
Description |
Sets PLATFORM with either “32-bit” or “64-bit” depending on the platform being installed on. |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
TurnOffGeneratePublisherEvidence1 & 2
|
Name |
TurnOffGeneratePublisherEvidence1 & 2 |
|
Type |
1025 –assembly: InstallerActions, Method: TurnOffGeneratePublisherEvidence |
|
Description |
This action reads the ManagementConsole.exe.config file and ensures that the generatePublisherEvidence element exists and is set to false. This will not have any effect during a normal install as the installed file has this set. This task is split into 2 due to limitations in the amount of information that can be passed in a single windows installer property Writes to: [BINDIR]AlertsServices.exe.config [BINDIR]DeploymentService.exe.config [BINDIR]EventsDispatcher.exe.config [BINDIR]SchedulerService.exe.config [BINDIR]ServerConfiguration.exe.config [BINDIR]AlertsServices.exe.config.tmp [BINDIR]DeploymentService.exe.config.tmp [BINDIR]EventsDispatcher.exe.config.tmp [BINDIR]SchedulerService.exe.config.tmp [BINDIR]ServerConfiguration.exe.config.tmp |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
TurnOffGeneratePublisherEvidenceCommit1 & 2
|
Name |
TurnOffGeneratePublisherEvidenceCommit1 & 2 |
|
Type |
1025 –assembly: InstallerActions, Method: TurnOffGeneratePublisherEvidenceCommit |
|
Description |
This action deletes any .tmp files created by TurnOffGeneratePublisherEvidence1 & 2 Deletes: [BINDIR]AlertsServices.exe.config.tmp [BINDIR]DeploymentService.exe.config.tmp [BINDIR]EventsDispatcher.exe.config.tmp [BINDIR]SchedulerService.exe.config.tmp [BINDIR]ServerConfiguration.exe.config.tmp |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
LaunchServerUninstall
|
Name |
LaunchServerUninstall |
|
Type |
3154 – executable: ServerConfig.exe |
|
Description |
This action launches the SCU with the /uninstall flag to perform generic uninstall actions: Stops all includes services Unregisters all services Stops all IIS AppPools Deletes all web directories & website filesystem directories Removes all AppPools |
|
Occurs During |
UnInstall |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
No |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
LaunchServerBeginUpgrade
|
Name |
LaunchServerBeginUpgrade |
|
Type |
3154 – executable: ServerConfig.exe |
|
Description |
This action launches the SCU with the /beginupgrade flag to perform generic upgrade actions: Stops all installed services |
|
Occurs During |
UnInstall |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
No |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
LaunchServerEndUpgrade
|
Name |
LaunchServerEndUpgrade |
|
Type |
3154 – executable: ServerConfig.exe |
|
Description |
This action launches the SCU with the /endupgrade flag to perform generic upgrade actions: Writes to the following webconfigs: [BINDIR]ActiveProductDefinition\Management Server.xml [BINDIR]AlertsServices.exe.config [BINDIR]DeploymentService.exe.config [BINDIR]EventsDispatcher.exe.config [BINDIR]SchedulerService.exe.config [BINDIR]ServerConfiguration.exe.config |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
No |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
RestartServicesPostRepair
|
Name |
RestartServicesPostRepair |
|
Type |
1 - Assembly: InstallerActions, Method: |
|
Description |
This action restarts the services at the end of a repair operation. This custom action does not require a corresponding commit custom action. |
|
Occurs During |
Repair |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
SetAppSenseServicesToRestart
|
Name |
SetAppSenseServicesToRestart |
|
Type |
1 - Assembly: InstallerActions, Method: |
|
Description |
This action reads a CustomActionData property listing all the AppSense Windows Services and determines which are running and which are currently stopped. This information is recorded and used if a rollback occurs to ensure that on completion of a rollback the service system state is the same. |
|
Occurs During |
Repair |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
No |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
RestartServicesPostRepairRollBack
|
Name |
RestartServicesPostRepairRollBack |
|
Type |
1 – Assembly: InstallerActions, Method RestartServicesPostRepairRollBack |
|
Description |
This action ensures that if a rollback occurs during a repair operation, the AppSense windows services have their initial service status as determined by the SetAppSenseServicesToRestart custom action. This custom action does not require a corresponding commit custom action. |
|
Occurs During |
Repair |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
Client Communications Agent Custom Actions
AppendAppSenseInstallMgrCM
|
Name |
AppendAppSenseInstallMgrCM |
|
Type |
1 - Assembly: InstallerActions, Method: AppendAppSenseInstallMgrCM |
|
Description |
Reads the registry string at HKLM\System\CurrentControlSet\Control\NetworkProvider\Order\ProviderOrder and then appends a comma separated string at the end which is the name of the Appsense credential manager hook dll. |
|
Occurs During |
Install |
|
Changes System State |
Yes |
|
Reversible |
Yes |
|
Execute |
Immediate |
|
Has Rollback |
Yes |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
Yes |
|
GacUtil |
No |
RemoveAppSenseInstallMgrCM
|
Name |
RemoveAppSenseInstallMgrCM |
|
Type |
1 - Assembly: InstallerActions, Method: RemoveAppSenseInstallMgrCM |
|
Description |
Reads the registry string at HKLM\System\CurrentControlSet\Control\NetworkProvider\Order\ProviderOrder and then removes the AppSense credential manager hook dll name from the string without corrupting the current network provider order. |
|
Occurs During |
UnInstall, Repair |
|
Changes System State |
Yes |
|
Reversible |
N/A |
|
Execute |
Deferred |
|
Has Rollback |
No |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
Yes |
|
GacUtil |
No |
EnterServerWarning
|
Name |
EnterServerWarning |
|
Type |
4134 – Embedded VBScript |
|
Description |
Displays a message box saying “Please enter the Management Server URL” if the user forgets during a manual install |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
CheckURL
|
Name |
CheckURL |
|
Type |
4134 – Embedded VBScript |
|
Description |
Checks whether a given URL is well-formed. Reads property MANAGEMENTSERVERURL Sets MANAGEMENTSERVERURL to canonical version if URL is good Set URL_OK to either “1” if good or empty string if bad URL |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
Yes |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
BadURL
|
Name |
BadURL |
|
Type |
4134 – Embedded VBScript |
|
Description |
Displays a message box saying “URL is invalid” if the user types a bad URL. Run if property URL_OK is empty. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
WixUIPrintEula
|
Name |
WixUIPrintEula |
|
Type |
65 – 3rd party assembly: WixUIWixca, Method: PrintEula |
|
Description |
Provides a button which allows the user to print the current EULA document from a ’Select Printer’ dialog. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
CheckBITS
|
Name |
CheckBITS |
|
Type |
1 –assembly: InstallerActions, Method: CheckBITS |
|
Description |
Checks if BITS is installed |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |
FormatWebSiteURL
|
Name |
FormatWebSiteURL |
|
Type |
1 –assembly: InstallerActions, Method: FormatWebSiteURL |
|
Description |
Appends a forward slash (/) to URL if none present and adds port number. |
|
Occurs During |
Install |
|
Changes System State |
No |
|
Reversible |
N/A |
|
Execute |
Immediate |
|
Has Rollback |
N/A |
|
MSIProcessMessage |
N/A |
|
Mis-uses MSI Prefixes |
No |
|
Set Registry Keys |
No |
|
GacUtil |
No |