Custom Actions for FIM 2010

Custom Actions for FIM 2010

The Windows Installer provides many built-in actions for performing the installation process. For a list of these actions, see the Standard Actions Reference.Standard actions are sufficient to execute an installation in most cases. However, there are situations where the developer of an installation package finds it necessary to write a custom action. For additional information on custom actions see Custom Actions.

The following sections will provide reference information on the various custom actions that FIM 2010 uses and a description of them.

  • FIM Synchronization Service Custom Actions

  • FIM Service and Portal Custom Actions

  • FIM Service and Portal Language Pack Custom Actions

  • Add-ins and Extensions Custom Actions

  • Add-ins and Extensions Language Packs Custom Actions

  • PCNS Custom Actions

  • FIM Certificate Management Custom Actions

  • FIM Certificate Management Client Custom Actions

  • FIM Certificate Management Bulk Client Custom Actions

FIM Synchronization Service Custom Actions

The following table is a list of custom actions that can be used when installing Synchronization Service.

Custom Action Custom Action Type Source Target Description

SetDBGroupsUpdateFlag

307

DBGROUPSUPDATE

1

Runs during change install and upgrade to set the parameters/properties needed by the 'ConfigDB' custom action to configure the database

ValidatePID

1

PidCa

ValidateProductID

Calls the ValidateProductId of the Pidca.dll to generate a Product ID

DeleteInstallConfigFile_MOSS

3073

SetupUtility

DeleteInstallConfigFile

Deletes the configuration xml file used by setup

DeleteWmiFile_MOSS

3073

SetupUtility

DeleteWMI

Calls IID_IMofCompiler::CompileFile a MOF (Managed Object Format) file

UnregisterPerfMon_MOSS

3073

SetupUtility

UnregisterPerfMon

Unregisters the performance objects and counters from the MSI

SxsInstallCA

1

SxsUninstallCA

CustomAction_SxsMsmInstall

custom action from the vc runtime merge module for side by side installation of the vc runtime files

SxsUninstallCA

1

SxsUninstallCA

CustomAction_SxsMsmCleanup

custom action from the vc runtime for cleanup of vc runtime files

SetInstallPath

291

SynchronizationService

[MIIS_PATH]

Set the installation path for the product based on the MIIS_PATH property. This property is set based on the value from the registry SYSTEM\CurrentControlSet\Services\FIMSynchronizationService\Parameters[Path]

ValidateGroups

1

SyncSetupUtl

ValidateGroups

Validates the Sync groups and schedule it for creation

CheckFileSystemWithoutMsg

1

SyncSetupUtl

CheckFileSystemWithoutMsg

Checks the file system to make sure it's NTFS type without UI error msg

ValidateGroupsWithoutMsg

1

SyncSetupUtl

ValidateGroupsWithoutMsg

Validates the Sync groups and schedule it for creation without UI error msg

CheckFirewallServiceRunning

1

SyncSetupUtl

CheckFirewallServiceRunning

Checks to make sure the firewall service is running

CheckSQLInstallationWithoutMsg

1

SyncSetupUtl

CheckSQLInstallationWithoutMsg

Check for SQL Server prerequisite

ValidateAccountWithoutMsg

1

SyncSetupUtl

ValidateAccountWithoutMsg

Validates a specific account without UI error msg

CheckServiceAccountSQLPermissionWithoutMsg

1

SyncSetupUtl

CheckServiceAccountSQLPermissionWithoutMsg

Checks the sync service account access permission on the SQL Server without UI error msg

CheckDotNetVersion

1

SyncSetupUtl

CheckDotNetVersion

Check .NET runtime version required

DeleteMachineDcomPermission

1

SyncSetupUtl

DeleteMachineDcomPermission

Removes the machine-wide dcom permission for the Sync groups

DetectMaDataFiles

1

SyncSetupUtl

DetectMADataFiles

Checks if the madata folder contains any file

GetServiceDependencies

1

SyncSetupUtl

GetServiceDependencies

Checks to make sure all dependent services are installed.

ValidateProductPID

1

SyncSetupUtl

ValidateProductPID

Validates the PID generated by the ValidatePID (PidCa.dll,ValidateProductID) custom action

CheckEvaluationPeriod

1

SyncSetupUtl

CheckEvaluationPeriod

Checks the evaluation period (time bomb) and blocks if expired

DetectServiceAccount

1

SyncSetupUtl

DetectServiceAccount

Retrieves the account currently configured on the sync service and set the account value to the 'SERVICEACCOUNT' property on a change install or upgrade so that the new service can be reconfigured with the same account

ValidateProductPIDWithoutMsg

1

SyncSetupUtl

ValidateProductPIDWithoutMsg

Validates the PID generated by the ValidatePID (PidCa.dll,ValidateProductID) custom action without UI error msg in of invalid PID.

CheckIISInstallation

1

SyncSetupUtl

CheckIISInstallation

Checks for make sure IIS is installed. Note that this custom action is defined but not been used. It should be removed from the MSI.

StopMMSService

1

SyncSetupUtl

StopMMSService

Stops the sync service

LogoffSystem

257

SyncSetupUtl

LogoffSystem

Logs off the current windows session

CheckFileSystem

257

SyncSetupUtl

CheckFileSystem

Checks the file system to make sure it's NTFS type

DetectStoreServer

257

SyncSetupUtl

DetectStoreServer

Gets the SQL Server name for the current installation and sets the value to the 'STORESERVER' property

DetectStoreServerIgnoreError

257

SyncSetupUtl

DetectStoreServerIgnoreError

custom action calls DetectStoreServer and always return successful (ignoring any error)

ValidateAccount

257

SyncSetupUtl

ValidateAccount

validates the supplied service account/credentials

ValidateProducts

257

SyncSetupUtl

ValidateProducts

validates the installed product on a major upgrade to make sure it the product (SKU) supported by the upgrading SKU.

GetGroupNamesFromDB

257

SyncSetupUtl

GetGroupNamesFromDB

Gets the group names from the SQL Server on an existing install of Sync

ProcessMachineDcomPermission

1025

SyncSetupUtl

ProcessMachineDcomPermission

Sets the DCOM permission for the Sync security groups

DeleteWMI

1025

SyncSetupUtl

DeleteWMI

Calls IID_IMofCompiler::CompileFile a MOF (Managed Object Format) file

StartMMSService

1025

SyncSetupUtl

StartMMSService

Starts the Sync service

RollbackServiceDependencies

1281

SyncSetupUtl

RollbackServiceDependencies

Removes the service dependencies from the sync service

RollbackSetup

1281

SyncSetupUtl

RollbackSetup

Called by a custom action to force a rollback of the setup

RollbackVDir

1281

SyncSetupUtl

DeleteVDir

This custom action is currently not been used. Not sure what it is for. It should be removed from the MSI.

RegisterPerfMon

3073

SyncSetupUtl

RegisterPerfMon

registers the performance objects and counters for the MSI

SetupWMI

3073

SyncSetupUtl

SetupWMI

Calls IID_IMofCompliler::CompileFile to compile the mmswmi.mof file

ConfigureWindowsFirewall

3073

SyncSetupUtl

ConfigureWindowsFirewall

Configures firewall settings for the Sync service

CreateInstallConfigFile

3073

SyncSetupUtl

CreateInstallConfigFile

Creates the InstallConfig.xml

DeleteInstallConfigFile

3073

SyncSetupUtl

DeleteInstallConfigFile

Deletes the InstallConfig.xml on uninstall

UnregisterPerfMon

3073

SyncSetupUtl

UnregisterPerfMon

Unregisters the performance objects and counters from the MSI

SetPermissionEval

3073

SyncSetupUtl

SetPermission

Set access permission (ACLs) for file folders, registry, DCOM launch/access permission and WMI

UpdateSourceProj

3073

SyncSetupUtl

UpdateSourceProj

Updates the install path in *.vbproj files

ValidateDebugPrivilege

3073

SyncSetupUtl

ValidateDebugPrivilege

Checks to make sure only builtin administrators have "SeDebugPrivilege" else popup a warning msg.

AddLocalGroup

3073

SyncSetupUtl

AddLocalGroup

Called by ValidateGroups & ValidateGroupsWithoutMsg custom actions to add the local sync groups

AddLocalGroupMember

3073

SyncSetupUtl

AddLocalGroupMember

Custom action to add local group members

RollbackWindowsFirewall

3329

SyncSetupUtl

ConfigureWindowsFirewall

Configures firewall settings for the Sync service

RollBackInstallConfigFile

3329

SyncSetupUtl

DeleteInstallConfigFile

Deletes the InstallConfig.xml on uninstall

RollbackRegisterPerfMon

3329

SyncSetupUtl

UnregisterPerfMon

Unregisters the performance objects and counters from the MSI

RollbackUnregisterPerfMon

3329

SyncSetupUtl

RegisterPerfMon

registers the performance objects and counters for the MSI

RollbackWMI

3329

SyncSetupUtl

DeleteWMI

Calls IID_IMofCompiler::CompileFile a MOF (Managed Object Format) file

RollbackDeleteMachineDcomPermission

3329

SyncSetupUtl

DeleteMachineDcomPermission

Removes the machine-wide dcom permission for the Sync groups

RollbackProcessMachineDcomPermission

3329

SyncSetupUtl

ProcessMachineDcomPermission

Sets the DCOM permission for the Sync security groups

RollbackLocalGroup

3329

SyncSetupUtl

AddLocalGroup

Called by ValidateGroups & ValidateGroupsWithoutMsg custom actions to add the local sync groups

RollbackLocalGroupMember

3329

SyncSetupUtl

AddLocalGroupMember

Custom action to add local group members

ConfigDB

9217

SyncSetupUtl

ConfigDB

configures the sync service database

DoCheckElevatedPrivileges

10497

SyncSetupUtl

DoCheckElevatedPrivileges

checks for elevated privileges required by setup

ChangeServiceAccount

11265

SyncSetupUtl

ChangeServiceAccount

Custom action to change the sync service account/credential

SetPolicyforServiceAccount

11265

SyncSetupUtl

SetPolicyforServiceAccount

sets the policy for the sync service account on install

SetServiceRecoveryActions

3073

WixCA

CAQuietExec

This is a generic wix library custom custom action for launching an exe

FIM Service and Portal Custom Actions

The following table is a list of custom actions that can be used when installing FIM Service and Portal.

Custom Action Custom Action Type Source Target Description

UninstallAppConfigSettingsInPatch

3074

AppConfigPopulator

Operation=RollbackPatch ConfigFilePath="[CommonServicesInstallDir]\Microsoft.ResourceManagement.Service.exe.config" DllFilePath="[CommonServicesInstallDir]\Microsoft.ResourceManagement.dll"

On patch uninstall, this custom action invokes an AppConfigPopulator binary which reverts the Microsoft.ResourceManagement.Service.exe.config file to what it used to be prior to applying the patch.

UpdateAppConfigSettingsInPatch

3074

AppConfigPopulator

Operation=Patch ConfigFilePath="[CommonServicesInstallDir]\Microsoft.ResourceManagement.Service.exe.config"

On patch install, invokes the AppConfigPopulator binary to update the Microsoft.ResourceManagement.Service.exe.config file.

RollbackAppConfigSettings

3330

AppConfigPopulator

Operation=Rollback ConfigFilePath="[CommonServicesInstallDir]\Microsoft.ResourceManagement.Service.exe.config"

If something goes wrong during install/change install, this invokes AppConfigPopulator to roll back the updates made by setup to the Microsoft.ResourceManagement.Service.exe.config file.

RollbackAppConfigSettingsInPatch

3330

AppConfigPopulator

Operation=RollbackPatch ConfigFilePath="[CommonServicesInstallDir]\Microsoft.ResourceManagement.Service.exe.config" DllFilePath="[CommonServicesInstallDir]\Microsoft.ResourceManagement.dll"

If something goes wrong when applying the patch, this invokes AppConfigPopulator to roll back the updates made by the patch to the Microsoft.ResourceManagement.Service.exe.config file

LaunchBrowserLinkToSQM

242

BROWSER

https://www.microsoft.com/products/ceip/EN-US/default.mspx

Launches the user's browser to read more about the Customer Experience Improvement Program

InstallCerts

11266

CertUtl

create "[CERTIFICATE_NAME]"

Generate a new self-issued certificate during install

DeleteCerts

11330

CertUtl

delete "ForefrontIdentityManager"

Deletes existing generated certificate

RollbackCerts

11586

CertUtl

delete "ForefrontIdentityManager"

Delete the generated certificate if install fails

BackupRMSDll

98

CommonDir

robocopy . .\backup Microsoft.ResourceManagement.dll

Backs up Microsoft.ResourceManagement.dll

BackupLogDll

98

CommonDir

robocopy . .\backup Microsoft.IdentityManagement.Logging.dll

Backs up Microsoft.IdentityManagement.Logging.dll

InstallPSExtension

3106

CommonDir

[WindowsFolder]\Microsoft.NET\Framework64\v2.0.50727\InstallUtil.exe /LogToConsole=false /InstallStateDir= /LogFile= Microsoft.ResourceManagement.Automation.dll

Installs the FIMAutomation PowerShell snapin and registers it for use with PowerShell

DeletePSExtension

3170

CommonDir

[WindowsFolder]\Microsoft.NET\Framework64\v2.0.50727\InstallUtil.exe /LogToConsole=false /InstallStateDir= /LogFile= /u Microsoft.ResourceManagement.Automation.dll

Uninstalls the FIMAutomation PowerShell snapin and de-registers it.

RollbackPSExtension

3426

CommonDir

[WindowsFolder]\Microsoft.NET\Framework64\v2.0.50727\InstallUtil.exe /LogToConsole=false /InstallStateDir= /LogFile= /u Microsoft.ResourceManagement.Automation.dll

Same action as Remove except that it is called during rollback of an installation due to other failures

DeployAndPopulateDatabase

1026

DatabaseDeployment

installApp=FIM action=DeployAndPopulateDatabase databaseName=[SQLSERVER_DATABASE] namespaceName="fim" datFilesInstallDir="[CommonServicesInstallDir]Data" sqlserverName=[SQLSERVER_SERVER] FIMServiceAccountDomain=[SERVICE_ACCOUNT_DOMAIN] FIMServiceAccountName=[SERVICE_ACCOUNT_NAME] SyncServiceAccountDomain=[SYNCHRONIZATION_SERVER_ACCOUNT_DOMAIN] SyncServiceAccountName=[SYNCHRONIZATION_SERVER_ACCOUNT_NAME] RunningUserDomain=[RUNNING_USER_DOMAIN] RunningUserName=[RUNNING_USER_NAME] RunningUserEmail=[RUNNING_USER_EMAIL] CreateDatabase=True

Deploys fresh FIM Service database - only on new clean installation

ReconfigureServiceAccounts

1026

DatabaseDeployment

installApp=FIM action=ReconfigureServiceAccounts databaseName=[SQLSERVER_DATABASE] namespaceName="fim" datFilesInstallDir="[CommonServicesInstallDir]Data" sqlserverName=[SQLSERVER_SERVER] FIMServiceAccountDomain=[SERVICE_ACCOUNT_DOMAIN] FIMServiceAccountName=[SERVICE_ACCOUNT_NAME] SyncServiceAccountDomain=[SYNCHRONIZATION_SERVER_ACCOUNT_DOMAIN] SyncServiceAccountName=[SYNCHRONIZATION_SERVER_ACCOUNT_NAME]

Sets up SQL Server Service account permissions correctly

RollbackReconfigureServiceAccounts

1346

DatabaseDeployment

installApp=FIM action=RollbackReconfigureServiceAccounts databaseName=[SQLSERVER_DATABASE] namespaceName="fim" datFilesInstallDir="[CommonServicesInstallDir]Data" sqlserverName=[SQLSERVER_SERVER] FIMServiceAccount=[SERVICE_ACCOUNT_PREV] SyncServiceAccount=[SYNCHRONIZATION_SERVER_ACCOUNT_PREV]

Remove the SQL Server Service account permissions if installation fails

StartMetabaseTransaction

11265

IIsExecute

StartMetabaseTransaction

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

WriteMetabaseChanges

11265

IIsExecute

WriteMetabaseChanges

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

AddMachineCertificate

11265

IIsExecute

AddMachineCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

DeleteMachineCertificate

11265

IIsExecute

DeleteMachineCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

RollbackMetabaseTransaction

11521

IIsExecute

RollbackMetabaseTransaction

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

RollbackAddMachineCertificate

11521

IIsExecute

DeleteMachineCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

RollbackDeleteMachineCertificate

11521

IIsExecute

AddMachineCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

CommitMetabaseTransaction

11777

IIsExecute

CommitMetabaseTransaction

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

AddUserCertificate

25601

IIsExecute

AddUserCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

DeleteUserCertificate

25601

IIsExecute

DeleteUserCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

RollbackAddUserCertificate

25857

IIsExecute

DeleteUserCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

RollbackDeleteUserCertificate

25857

IIsExecute

AddUserCertificate

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

ConfigureIIs

1

IIsSchedule

ConfigureIIs

Built-in WiX custom action that has to be called to configure IIS with the Registration/Reset portal settings

InstallCertificates

1

IIsSchedule

InstallCertificates

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

UninstallCertificates

1

IIsSchedule

UninstallCertificates

Inserted automatically into the MSI when the WiX IIS extension is used to deploy the Registration/Reset portal websites

ConfigureIIsExec

3073

IIsSchedule

ConfigureIIsExec

Built-in WiX custom action that has to be called to configure IIS with the Registration/Reset portal settings

CheckFIMServiceRunningBeforePatch

8193

ILMSetupUtl

CheckFIMServiceRunningBeforePatch

Check if the FIM Service is running prior to executing a patch. The FIM service has to be stopped prior to patching

TrimBaseSiteCollectionUrl

1

ILMSetupUtl

TrimBaseSiteCollectionUrl

Trims the SharePoint base site collection URL provided during setup, removes trailing "/" if any and sets an MSI property with the trimmed value.

CheckDBVersion

257

ILMSetupUtl

CheckDBVersion

Reads the database version from the version table in the FIM Service database.

DetectServiceAccount

257

ILMSetupUtl

DetectServiceAccount

Detects the service account.

RollbackDatabase

1281

ILMSetupUtl

RollbackDatabase

Rolls back the database.

GACRMSDll

3073

ILMSetupUtl

RegisterAssemblies

Insert Microsoft.ResourceManagement.dll and Microsoft.IdentityManagement.Logging.dll into the GAC

ConfigureWindowsFirewall

3073

ILMSetupUtl

ConfigureWindowsFirewall

Create firewall rules for the FIM service/SSPR portals

RollbackWindowsFirewall

3329

ILMSetupUtl

ConfigureWindowsFirewall

Remove firewall rules for the FIM service/SSPR portals

ValidateResetAppPoolAccount

8193

ILMSetupUtl

ValidateResetAppPoolAccount

Validate that the password reset portal application pool account provided during setup is valid

CheckSQLServerAgent

8193

ILMSetupUtl

CheckSQLServerAgent

Checks to see if SQL Server Agent is running.

CheckDatabaseNameFormat

8193

ILMSetupUtl

CheckDatabaseNameFormat

Verifies the database name format.

CheckSQLConnectionAndVersion

8193

ILMSetupUtl

CheckSQLConnectionAndVersion

Verifies SQL connectivity and the SQL version.

CheckSynchronizationServiceExists

8193

ILMSetupUtl

CheckSynchronizationServiceExists

Verify that the synchronization service name provided during setup exists on the provided hostname

ValidateSyncAccount

8193

ILMSetupUtl

ValidateSyncAccount

Validate that the provided sync account is valid and not that of the running user or the FIM service account

ValidateServiceAccount

8193

ILMSetupUtl

ValidateAccountWithoutMessage

Validate that the provided FIM service account is valid and in the correct format

CheckServiceAccountSQLPermission

8193

ILMSetupUtl

CheckServiceAccountSQLPermissionWithoutMessage

Verifies the Service account permissions.

CheckServiceEmailAccountFormat

8193

ILMSetupUtl

CheckServiceEmailAccountFormat

Verify that the provided FIM service email account is in a valid email format

CheckDotNetVersion

8193

ILMSetupUtl

CheckDotNetVersion

Verifies the version of Dot Net on the current machine is 3.5 or higher

CheckMailServerAddressFormat

8193

ILMSetupUtl

CheckMailServerAddressFormat

Check if the provided mail server address is in the correct format

PopulateCerts

8193

ILMSetupUtl

PopulateCerts

Display a list of certificates in the certificate store and allow the user to select a certificate

CheckFirewallServiceRunning

8193

ILMSetupUtl

CheckFirewallServiceRunning

Verify that the firewall service is running prior to setting firewall rules

CheckServiceExists

8193

ILMSetupUtl

CheckServiceExists

Verify that the FIM service exists and running. Set two MSI properties (exists/running) based on the results

ValidateRegistrationAppPoolAccount

8193

ILMSetupUtl

ValidateRegistrationAppPoolAccount

Validate that the password registration portal application pool account provided during setup is valid

SetGlobalMailSuffixProperty

8193

ILMSetupUtl

SetGlobalMailSuffixProperty

Push the part after the "@" in the FIM service address to another MSI property

GetRunningAccount

8193

ILMSetupUtl

GetAccountFromSid

Get the account name and domain from a SID string

TranslateSIDToDisplayName

8193

ILMSetupUtl

TranslateSIDToDisplayName

Based on a user/group's SID, gets the localized display name (domain\user) to be used for permission setting.

CheckIfRunningUserSysadmin

8449

ILMSetupUtl

CheckIfRunningUserSysadmin

Checks if the running user has a Sysadmin role in the SQL database

CheckFullTextSearchInstalled

8449

ILMSetupUtl

CheckFullTextSearchInstalled

Verifies Full Text Search is installed.

CheckDatabaseExists

8449

ILMSetupUtl

CheckDatabaseExists

Checks to see if database already exists.

CheckDatabaseOptions

8449

ILMSetupUtl

CheckDatabaseOptions

Checks database options.

DoCheckElevatedPrivileges

10497

ILMSetupUtl

DoCheckElevatedPrivileges

Verify if setup is running with Administrator privileges

SetPolicyforServiceAccount

11265

ILMSetupUtl

SetPolicyforServiceAccount

Sets the policy for the service account.

GetCertThumbprintFromName

11265

ILMSetupUtl

GetCertThumbprintFromName

Helper function to PopulateCerts

UpgradeDatabase

1042

Microsoft.IdentityManagement.DatabaseUpgrade.exe

/ConnectionString:"Data Source=[SQLSERVER_SERVER];Initial Catalog=[SQLSERVER_DATABASE];Integrated Security=SSPI;Pooling=true;Connection Timeout=225" /FimServiceAccountName:"[SERVICE_ACCOUNT_DOMAIN]\[SERVICE_ACCOUNT_NAME]" /FimServiceDatabaseName:"[SQLSERVER_DATABASE]"

Upgrades the FIM Service database

GetIISVersionFromRegistry

8193

PasswordResetCAs

GetIISVersion

Determine the version of IIS from the registry

GetIISPortalPorts

8193

PasswordResetCAs

GetIISPortalPorts

Get the portal ports from IIS (if the SSPR portals were installed) and store them in an MSI property

ValidateResetPort

8193

PasswordResetCAs

ValidateResetPort

Validate that the reset port value is valid

ValidateRegistrationPort

8193

PasswordResetCAs

ValidateRegistrationPort

Validate that the registration port value is valid

BackupWebConfigValues

8193

PasswordResetCAs

BackupWebConfigValues

Backup the server name and security context assersion values in the registration/reset portal web.config

UpdateResetWebConfig

9217

PasswordResetCAs

UpdateWebConfig

Update the password reset portal web.config with the values specified in setup

UpdateVersionInResetWebConfig

9217

PasswordResetCAs

UpdateVersionInWebConfig

Set the password reset portal assembly versions in the web.config

UpdateRegistrationWebConfig

9217

PasswordResetCAs

UpdateWebConfig

Update the password registration portal web.config with the values specified in setup

UpdateVersionInRegistrationWebConfig

9217

PasswordResetCAs

UpdateVersionInWebConfig

Set the password registration portal assembly versions in the web.config

SetAuthenticationModeForRegistration

9217

PasswordResetCAs

SetAuthenticationForRegistrationSite

Set the authentication mode in IIS for the registration portal as Windows Authentication

RollbackUpdateRegistrationWebConfig

9537

PasswordResetCAs

UpdateWebConfig

Rollback updates made to the password registration portal web.config file

RollbackUpdateResetWebConfig

9537

PasswordResetCAs

UpdateWebConfig

Rollback updates made to the password reset portal web.config file

VerifyServiceManagerConsoleInstall

1

ReportingCAs

VerifyServiceManagerConsoleInstall

Verifies the correct version of System Center Console and patches are installed

VerifyServiceManagerServer

1

ReportingCAs

VerifyServiceManagerServer

Verifies the SCSM MS services are running on the machine specified

SetServiceManagerPermissionProperty

1

ReportingCAs

SetServiceManagerPermissionProperty

Sets the permissions for the FIM Service account on Service Manager

GetSchemaManagementPackStatus

1

ReportingCAs

GetManagementPackStatus

Depricated No longer used

GetManagementPackBundleStatus

1

ReportingCAs

GetManagementPackBundleStatus

Before installing a mangement pack bundle, checks to see if it is already installed and deployed

GetRequestHistoryManagementPackBundleStatus

1

ReportingCAs

GetManagementPackBundleStatus

Looks for Request History Management Pack bundle and sees if this installed and deployed

SetEnableReportingProperty

1

ReportingCAs

SetEnableReportingProperty

Sets a registry key entry DWORD Reporting Enabled = 1

VerifyServiceManagerConsoleInstallUI

65

ReportingCAs

VerifyServiceManagerConsoleInstall

Depricated

VerifyServiceManagerServerUI

65

ReportingCAs

VerifyServiceManagerServer

Depricated

AddServiceManagerPermission

1025

ReportingCAs

AddServiceManagerPermission

Sets FIM Service account to Service Manager account

ImportSchemaManagementPack

1025

ReportingCAs

ImportManagementPack

Depricated

ImportReportManagementPackBundle

1025

ReportingCAs

ImportManagementPackBundle

Imports a Report Management bundle using Service Manager SDK into service manager

ImportRequestHistoryReportManagementPackBundle

1025

ReportingCAs

ImportManagementPackBundle

Imports a Report Management bundle using Service Manager SDK into service manager

RollbackAddServiceManagerPermission

1345

ReportingCAs

RemoveServiceManagerPermission

Rolls back permissions on the Service Manager side

RollbackImportSchemaManagementPack

1345

ReportingCAs

RollbackManagementPack

Depricated

RollbackImportReportManagementPackBundle

1345

ReportingCAs

RollbackManagementPack

Uninstalls the management pack bundle if setup fails

RollbackImportRequestHistoryReportManagementPackBundle

1345

ReportingCAs

RollbackManagementPack

Uninstalls the management pack bundle if setup fails

StartManagementPackSyncJob

1601

ReportingCAs

StartManagementPackSyncJob

Starts the MPSync Job

CreateUser

11265

ScaExecute

CreateUser

Part of the WiX library

CreateUserRollback

11521

ScaExecute

RemoveUser

Part of the WiX library

RemoveUser

11841

ScaExecute

RemoveUser

Part of the WiX library

ConfigureUsers

1

ScaSchedule

ConfigureUsers

Part of the WiX library

AddServiceToPerformanceMonitors

3073

ServerCustomActions

AddServiceToPerformanceMonitors

Allows FIM Service account to read Performance Monitor counters

RemoveServiceFromPerformanceMonitors

3137

ServerCustomActions

RemoveServiceFromPerformanceMonitors

Remove the FIM Service account to read Performance Monitor counters

RollbackAddServiceToPerformanceMonitors

3393

ServerCustomActions

RemoveServiceFromPerformanceMonitors

Same as Remove FIM Service account to read Performance Monitor counters

RollbackRemoveServiceFromPerformanceMonitors

3393

ServerCustomActions

AddServiceToPerformanceMonitors

Same as Add FIM FIM Service account to read Performance Monitor counters

SetSERVICE_ACCOUNT_PASSWORD

8243

SERVICE_ACCOUNT_PASSWORD

[SERVICE_ACCOUNT_PASSWORD]

Sets the SERVICE_ACCOUNT_PASSWORD property with the FIM service account password provided by the user

SetServiceAddressFromRegistry

307

SERVICEADDRESS

[SERVICEADDRESS_REGISTRY]

Populate an MSI property with the FIM Service address from the registry.

RemoveFimConfiguration

1

SetupUtility

IlmWebServiceUninstall

Custom action is defined but not called anywhere

CheckSharepointTimerServiceRunning

2

SharepointUtility

action=ISTIMERSERVICESTARTED UILevel=[UILevel]

Verify if the SharePoint timer service is running

CheckSharepointFarmAdministratorWithOpenPermission

2

SharepointUtility

action=ISFARMADMINISTRATORWITHOPENPERMISSION absoluteURL="[SHAREPOINT_URL]" UILevel=[UILevel]

Verify if the Open permission is set on the SharePoint farm administrator

CheckSharepointWebApporSiteExisting

2

SharepointUtility

action=IsDefaultWebApplicationOrSiteExisted absoluteURL="[SHAREPOINT_URL]" UILevel=[UILevel]

Check if the SharePoint base site collection URL provided by setup actually exists

CheckSharepointAdminServiceRunning

2

SharepointUtility

action=ISADMINSERVICESTARTED UILevel=[UILevel]

Verify if the SharePoint admin service is running

CheckFIMWebSiteorSolutionPackExisting

258

SharepointUtility

action=ISFIMWEBSITEORSOLUTIONPACKEXISTED absoluteURL="[SHAREPOINT_URL]" relativeURL="identitymanagement" solutionPackName=MicrosoftIdentityManagement.wsp commonSolutionPackName=MicrosoftILMPortalCommonDlls.wsp UILevel=[UILevel]

Verify if a FIM website/solution pack exists on top of SharePoint

FIMPortalConfigReadAccess

1026

SharepointUtility

action=AddUser siteUrl=[SHAREPOINT_SITE_URL] accessType=Reader loginName="[AUTHENTICATED_USERS]" UILevel=[UILevel]

Configure Read access to the FIM portal

SchedXmlConfig

1

WixCA

SchedXmlConfig

Part of the WiX library

WixUIPrintEula

65

WixCA

PrintEula

Custom action to display the EULA. Implementation provided by WiX out of the box.

InstallCommonPortal

1025

WixCA

CAQuietExec

Install the common portal DLLs

InstallFIMPortal

1025

WixCA

CAQuietExec

Install the FIM portal solution pack

UninstallCommonPortal

1025

WixCA

CAQuietExec

Uninstall the common portal DLLs

UninstallFIMPortal

1025

WixCA

CAQuietExec

Retract/remove the FIM portal solution pack

PatchRemoveCommonPortal

1025

WixCA

CAQuietExec

Uninstall the existing common portal DLLs on patch

PatchRemoveFIMPortal

1025

WixCA

CAQuietExec

Retract/remove the FIM portal solution pack on patch

RollbackInstallCommonPortal

1345

WixCA

CAQuietExec

Rollback the installation of common portal DLLs if setup fails

RollbackInstallFIMPortal

1345

WixCA

CAQuietExec

Rollback the installation of FIM portal solution pack if setup fails

RollbackChangeCommonPortal

1345

WixCA

CAQuietExec

Rollback change installing the common portal DLLs if setup fails

RollbackChangeFIMPortal

1345

WixCA

CAQuietExec

Rollback the re-deployment of the FIM portal solution pack if setup fails

SetServiceRecoveryActions

3073

WixCA

CAQuietExec

Call sc.exe to set the recovery parameters on theFIM service

AclResourceEndpoint

3073

WixCA

CAQuietExec

Set the ACLs on theFIM service endpoint

AclSecurityEndpoint

3073

WixCA

CAQuietExec

Set the ACLs on the security token endpoint

AclCertificates

3073

WixCA

CAQuietExec

Set the ACLs on server certificates

ExecXmlConfig

3073

WixCA

ExecXmlConfig

Part of the WiX library

DeleteResourceEndpointAcl

3137

WixCA

CAQuietExec

Delete the existing ACLs set on theFIM service endpoint

DeleteSecurityEndpointAcl

3137

WixCA

CAQuietExec

Delete the existing ACLs set on the security token endpoint

RollbackAclCertificates

3329

WixCA

CAQuietExec

Revoke ACLs set on certificates set on server certificates if setup fails

ExecXmlConfigRollback

3329

WixCA

ExecXmlConfigRollback

Part of the WiX library

RollbackAclResourceEndpoint

3393

WixCA

CAQuietExec

Revoke ACLs set on the FIM service endpoint if setup fails

RollbackAclSecurityEndpoint

3393

WixCA

CAQuietExec

Revoke ACLs set on the security token endpoint if setup fails

FIM Service and Portal Language Pack Custom Actions

The following table is a list of custom actions that can be used when installing the FIM Service and Portal Language Packs.

Custom Action Custom Action Type Source Target Description

TrimBaseSiteCollectionUrl

1

ILMSetupUtl

TrimBaseSiteCollectionUrl

Trims the SharePoint base site collection URL provided during setup, removes trailing "/" if any and sets an MSI property with the trimmed value.

DoCheckElevatedPrivileges

10497

ILMSetupUtl

DoCheckElevatedPrivileges

Check if the installer was run with Administrator privileges

CheckSharepointTimerServiceRunning

2

SharepointUtility

action=ISTIMERSERVICESTARTED UILevel=[UILevel]

Check if the SharePoint timer service is running.

CheckSharepointWebApporSiteExisting

2

SharepointUtility

action=IsDefaultWebApplicationOrSiteExisted absoluteURL="[SHAREPOINT_URL]" UILevel=[UILevel]

Check if the SharePoint base site collection URL provided by setup actually exists

SchedXmlFile

1

WixCA

SchedXmlFile

Part of the WiX library

WixUIPrintEula

65

WixCA

PrintEula

Custom action to display the EULA. Implementation provided by WiX out of the box.

InstallSolutionPackdeDE

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackjaJP

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackesES

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackfrFR

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackitIT

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPacknlNL

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackptPT

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackzhTW

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

InstallSolutionPackzhCN

1025

WixCA

CAQuietExec

Deploys the solution pack of the given language pack to SharePoint.

PatchSolutionPacks

1025

WixCA

CAQuietExec

Redeploys the new SharePoint solution packs for the language packs during patch

FIMServiceResourceLocalizer

1025

WixCA

CAQuietExec

Updates the FIM service with the localized resource strings

UninstallSolutionPackdeDE

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackjaJP

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackesES

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackfrFR

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackitIT

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPacknlNL

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackptPT

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackzhTW

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

UninstallSolutionPackzhCN

1089

WixCA

CAQuietExec

Removes the solution pack of the given language pack from SharePoint.

RollbackSolutionPackdeDE

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackdeDE

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackjaJP

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackjaJP

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackesES

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackesES

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackfrFR

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackfrFR

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackitIT

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackitIT

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPacknlNL

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPacknlNL

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackptPT

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackptPT

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackzhTW

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackzhTW

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackSolutionPackzhCN

1345

WixCA

CAQuietExec

Rollback deployment of SharePoint solution pack for the given language pack if installation fails.

RollbackUninstallSolutionPackzhCN

1345

WixCA

CAQuietExec

Rollback retraction/removal of SharePoint solution pack for the given language pack if uninstallation fails.

RollbackPatchSolutionPacks

1345

WixCA

CAQuietExec

Rollback language pack SharePoint solution pack re-deployment if setup fails during patching.

ExecXmlFile

3073

WixCA

ExecXmlFile

Part of the WiX library

ExecXmlFileRollback

3329

WixCA

ExecXmlFileRollback

Part of the WiX library

Add-ins and Extensions Custom Actions

The following table is a list of custom actions that can be used when installing the FIM Add-ins and Extensions.

Custom Action Custom Action Type Source Target Description

LaunchBrowserLinkToSQM

242

BROWSER

https://www.microsoft.com/products/ceip/EN-US/default.mspx

Launches a browser to read more about the customer experience program.

SaveExistingTrustedSitesState

8193

CommonCustomActions

SaveExistingTrustedSitesStateForFimClient

Depricated from old client

RegisterTrustedSites

11265

CommonCustomActions

RegisterTrustedSitesForFimClient

Depricated from old client

UnregisterTrustedSites

11265

CommonCustomActions

UnregisterTrustedSitesForFimClient

Depricated from old client

RollbackForRegisterTrustedSites

11585

CommonCustomActions

UnregisterTrustedSitesForFimClient

Depricated from old client

RollbackToRestoreTrustedSites

11585

CommonCustomActions

RollbackToRestoreTrustedSitesForFimClient

Depricated from old client

CheckDotNetVersion

8193

ILMSetupUtl

CheckDotNetVersion

Verifies the version of Dot Not 3.5 or higher

CheckOutlookVersion

8193

ILMSetupUtl

CheckOutlookVersion

Verifies the Outlook verison is 2007

CheckMonitoredEmailFormat

8193

ILMSetupUtl

CheckMonitoredEmailFormat

Makes sure the FIM service account email address specified during setup is in a valid email address format

TranslateSIDToDisplayName

8193

ILMSetupUtl

TranslateSIDToDisplayName

Used by password reset extensions setup. Based on a user/group's SID, gets the localized display name (domain\user) to be used for permission setting.

GetValuesFromPortalURL

8449

ILMSetupUtl

GetValuesFromPortalURL

Get the Outlook add-in FIM portal URL value specified in setup and stores the protocol and address in two MSI properties

GetRMSLocation

8449

ILMSetupUtl

GetRMSLocation

Get the FIM service address used by the password client during registration/reset

RegisterOfficeAddIn

11265

ILMSetupUtl

RegisterOfficeAddIn

Register the FIM add-in in Outlook during installation by setting/incrementing the appropriate registry values

UnRegisterOfficeAddIn

11265

ILMSetupUtl

UnRegisterOfficeAddIn

Unregister the FIM add-in from Outlook during uninstallation

RollbackRegisterOfficeAddIn

11521

ILMSetupUtl

UnRegisterOfficeAddIn

Rollback registration of FIM Outlook add-in if installation fails

SetSITELOCK_DOMAIN

307

SITELOCK_DOMAIN

[SITELOCK_DOMAINX86]

Depricated from old client

WixUIPrintEula

65

WixCA

PrintEula

Custom action to display the EULA. Implementation provided by WiX out of the box.

RegisterClientDll

3073

WixCA

CAQuietExec

Uses regasm.exe to register Microsoft.IdentityManagement.Client.Office.dll

SetServiceRecoveryActions

3073

WixCA

CAQuietExec

Call sc.exe to set the recovery parameters on the password reset client service

UnregisterClientDll

3137

WixCA

CAQuietExec

Uses regasm.exe to unregister Microsoft.IdentityManagement.Client.Office.dll during uninstall

UnregisterClientDllRollback

3393

WixCA

CAQuietExec

Uses regasm.exe to unregister Microsoft.IdentityManagement.Client.Office.dll during rollback

Add-ins and Extensions Language Packs Custom Actions

The following table is a list of custom actions that can be used when installing the Add-ins and Extensions Language Packs.

Custom Action Custom Action Type Source Target Description

WixUIPrintEula

65

WixCA

PrintEula

Custom action to display the EULA. Implementation provided by WiX out of the box.

PCNS Custom Actions

The following table is a list of custom actions that can be used when installing PCNS.

Custom Action Custom Action Type Source Target Description

_CopySchemaFile

1

SetupUtl

DLLCopySchemaFile

This custom action copies the schema LDIF file from the Binary table to:

_SetMachineRole

1

SetupUtl

DLLSetMachineRole

This custom action sets the MACHINEROLE property to one of the following:

_SetSchemaProperties

1

SetupUtl

DLLSetSchemaProperties

This custom action sets properties that identify whether the AD schema is updated for PCNS or not.

_UpdateSchemaProgressSet

1

SetupUtl

DLLUpdateSchema

This custom action updates the Active Directory schema for use with PCNS.

SxsInstallCA

1

SetupUtl

CustomAction_ScsMsmInstall

Standalone - Standalone workstation or server.

SxsUninstallCA

1

SetupUtl

CustomAction_SxsMsmCleanup

Member - Member workstation or server.

_UpdateSchema2

1

SetupUtl

DLLUpdateSchema

This custom action updates the Active Directory schema for use with PCNS.

_CreateConfigContainer

1

SetupUtl

DLLCreateConfigContainer

Creates the container object in AD.

_DeleteFolder2

1

SetupUtl

DLLRemoveFolder

Removes a folder and all of the contents. Uses the property 'DeleteFolder' for the path of the folder to remove."

_SetPermissions

1

SetupUtl

DLLSetPermissions

Sets permission for service key, folders and AD container.

FIM Certificate Management Custom Actions

The following table is a list of custom actions that can be used when installing FIM Certificate Management.

Custom Action Custom Action Type Source Target Description

UpgradeDatabase

1058

BIN

[BIN]Microsoft.Clm.Config.exe /DB

Upgrades the FIM CM database to the latest version

CleanWebApp

1285

CA.JS

MsiDeleteClmWebApp

Deletes the FIM CM application pool and it's corresponding virtual directory

RestoreIIS7Settings

1285

CA.JS

MsiRestoreIIS7Settings

Restores IIS settings to the backup created when the product was installed

SetCustomUI

4101

CA.JS

MsiSetCustomUIServer

Sets the location of custom installer dialogs for the FIM CM Server

ShowDebugMsg

4101

CA.JS

MsiShowDebugMsg

If running in Debug mode, creates a message box displaying installation/upgrade settings for the FIM CM Server

caValidateWebDir

4101

CA.JS

MsiValidateWebDir

Validates that FIM CM IIS virtual directory doesn't already exist or is invalid

BackUpSettings

4101

CA.JS

MsiBackUpServer

Backs up FIM CM files. If the server is installed, backs up IIS configuration, Web.config file, clmutil config file and FIM CM service config file. If the CA is installed, backs up FIM CM policy module and Exit module settings

UpgradeSettings

4101

CA.JS

MsiRestoreServer

Restores FIM CM files from backup.

CheckIfASPDotNetIsInstalled

4101

CA.JS

MsiCheckForASPDotNet

Verifies that IIS and ASP.NET are installed

StartCAService

4165

CA.JS

MsiStartCAService

Starts Certificate Services

CheckForEnterpriseCA

4357

CA.JS

MsiCheckForEnterpriseCA

Verifies that an Enterprise CA is installed

CreateWebApp

5125

CA.JS

MsiCreateClmWebApp

Creates the FIM CM application pool and it's corresponding virtual directory

DeleteWebApp

5189

CA.JS

MsiDeleteClmWebApp

Deletes the FIM CM application pool and it's corresponding virtual directory

SetDefaultPolicyModule

5637

CA.JS

MsiSetDefaultPolicyModule

Sets Microsoft's default policy module as the active policy module

SetCustomPolicyModule

5637

CA.JS

MsiSetCustomPolicyModule

Sets the FIM CM policy module as the active policy module

CheckDotNetVersion

8193

CMSetupUtl

CheckDotNetVersion

Validates that, at minimum, version 3.5 of the .NET framework is installed

DoCheckElevatedPrivileges

10497

CMSetupUtl

DoCheckElevatedPrivileges

Verifies that the installer is run with elevated privileges

InstallUtilCaching_BIN

50

INSTALLUTILPATH

/LogToConsole=false "[WEB_BIN]Microsoft.Practices.EnterpriseLibrary.Caching.dll"

Invokes installutil to install the EnterpriseLibrary's Caching Application block

InstallUtilCommon_BIN

50

INSTALLUTILPATH

/LogToConsole=false "[WEB_BIN]Microsoft.Practices.EnterpriseLibrary.Common.dll"

Invokes installutil to install the EnterpriseLibrary's Common Application block

UnInstallUtilCaching_BIN

114

INSTALLUTILPATH

/LogToConsole=false "[WEB_BIN]Microsoft.Practices.EnterpriseLibrary.Caching.dll"

Invokes installutil to uninstall the EnterpriseLibrary's Caching Application block

UnInstallUtilCommon_BIN

114

INSTALLUTILPATH

/LogToConsole=false "[WEB_BIN]Microsoft.Practices.EnterpriseLibrary.Common.dll"

Invokes installutil to uninstall the EnterpriseLibrary's Common Application block

RollbackCaching_BIN

1394

INSTALLUTILPATH

/LogToConsole=false /u "[WEB_BIN]Microsoft.Practices.EnterpriseLibrary.Caching.dll"

Invokes installutil to roll-back the EnterpriseLibrary's Caching Application block

RollbackCommon_BIN

1394

INSTALLUTILPATH

/LogToConsole=false /u "[WEB_BIN]Microsoft.Practices.EnterpriseLibrary.Common.dll"

Invokes installutil to roll-back the EnterpriseLibrary's Common Application block

LAUNCH_MY_PROGRAM_PLEASE

51

LAUNCHPROGRAM

0

Launches the installed program

RegisterPolicyModule

50

REGASMPATH

[CA]Microsoft.Clm.PolicyModule.dll /codebase

Invokes the Assembly Registration tool to register the FIM CM Policy Module

RegisterExitModule

50

REGASMPATH

[CA]Microsoft.Clm.ExitModule.dll /codebase

Invokes the Assembly Registration tool to register the FIM CM Exit Module

UnRegisterPolicyModule

114

REGASMPATH

[CA]Microsoft.Clm.PolicyModule.dll /silent /unregister

Invokes the Assembly Registration tool to unregister the FIM CM Policy Module

UnRegisterExitModule

114

REGASMPATH

[CA]Microsoft.Clm.ExitModule.dll /silent /unregister

Invokes the Assembly Registration tool to unregister the FIM CM Exit Module

RollbackRegisterPolicyModule

1394

REGASMPATH

[CA]Microsoft.Clm.PolicyModule.dll /silent /unregister

Invokes the Assembly Registration tool to unregister the FIM CM Policy Module

RollbackRegisterExitModule

1394

REGASMPATH

[CA]Microsoft.Clm.ExitModule.dll /silent /unregister

Invokes the Assembly Registration tool to unregister the FIM CM Exit Module

SetCAModulesOnly

38

If Session.Property("CAMODULESONLY") <> "" Then Session.FeatureRequestState("Web_Files") = 2 Session.FeatureRequestState("Utilities") = 2 End If

Sets the "CAModulesOnly" property. This property is used when deciding what components to install on the server

SxsInstallCA

1

SxsUninstallCA

CustomAction_SxsMsmInstall

Including the Visual Studio 2005 SP1 merge modules for the Visual C++ 8 Runtime in your installation package causes two Microsoft custom actions to be included in your installation package (SxsInstallCA and SxsUninstallCA). These custom actions contain additional logging and debugging logic that gets run automatically when the MsiLogging property value contains the "v" and "x" switches and can add SIGNIFICANT time to the install/uninstall process.

SxsUninstallCA

1

SxsUninstallCA

CustomAction_SxsMsmCleanup

Including the Visual Studio 2005 SP1 merge modules for the Visual C++ 8 Runtime in your installation package causes two Microsoft custom actions to be included in your installation package (SxsInstallCA and SxsUninstallCA). These custom actions contain additional logging and debugging logic that gets run automatically when the MsiLogging property value contains the "v" and "x" switches and can add SIGNIFICANT time to the install/uninstall process

FIM Certificate Management Client Custom Actions

The following table is a list of custom actions that can be used when installing FIM Certificate Management Client.

Custom Action Custom Action Type Source Target Description

SetCustomUI

5

CA.JS

MsiSetCustomUIBlank

Sets the location of custom installer dialogs for the FIM CM Client

ShowDebugMsg

5

CA.JS

MsiShowDebugMsg

If running in Debug mode, creates a message box displaying installation/upgrade settings for the FIM CM Client

caValidateWebDir

5

CA.JS

MsiValidateWebDir

Validates that FIM CM IIS virtual directory doesn't already exist or is invalid

UpgradeSettings

5

CA.JS

MsiRestoreClient

Restores FIM CM client settings from backup.

BackUpSettings

517

CA.JS

MsiBackUpClient

Backs up FIM CM Client settings stored in registry keys

CheckDotNetVersion

8193

CMSetupUtl

CheckDotNetVersion

Validates that, at minimum, version 3.5 of the .NET framework is installed

SaveExistingTrustedSitesState

8193

CommonCustomActions

SaveExistingTrustedSitesStateForCMClient

Stores the list of current trusted sites on the client machine

RegisterTrustedSites

11265

CommonCustomActions

RegisterTrustedSitesForCMClient

Adds the FIM CM site to the list of trusted sites in the registry

UnregisterTrustedSites

11265

CommonCustomActions

UnregisterTrustedSitesForCMClient

Removes the FIM CM site from the list of trusted sites in the registry

RollbackForRegisterTrustedSites

11585

CommonCustomActions

UnregisterTrustedSitesForCMClient

Removes the FIM CM site from the list of trusted sites in the registry

RollbackToRestoreTrustedSites

11585

CommonCustomActions

RollbackToRestoreTrustedSitesForCMClient

Rolls back the addition of FIM CM site from the list of trusted sites in the registry

ValidatePID

1

PIDCA

ValidateProductID

Checks whether a product has validated successfully by checking the ProductID property. The installer sets the ProductID property to the full product identifier after a successful validation.

SxsInstallCA

1

SxsUninstallCA

CustomAction_SxsMsmInstall

Including the Visual Studio 2005 SP1 merge modules for the Visual C++ 8 Runtime in your installation package causes two Microsoft custom actions to be included in your installation package (SxsInstallCA and SxsUninstallCA). These custom actions contain additional logging and debugging logic that gets run automatically when the MsiLogging property value contains the "v" and "x" switches and can add SIGNIFICANT time to the install/uninstall process.

SxsUninstallCA

1

SxsUninstallCA

CustomAction_SxsMsmCleanup

Including the Visual Studio 2005 SP1 merge modules for the Visual C++ 8 Runtime in your installation package causes two Microsoft custom actions to be included in your installation package (SxsInstallCA and SxsUninstallCA). These custom actions contain additional logging and debugging logic that gets run automatically when the MsiLogging property value contains the "v" and "x" switches and can add SIGNIFICANT time to the install/uninstall process

InvalidKeyErrorMsg

38

dim rec set rec = Session.Installer.CreateRecord( 1 ) rec.IntegerData(1) = 30007 Session.Message &H01000000, rec

Displays the error message "The product key is not valid."

EvalKeyErrorMsg

38

dim rec set rec = Session.Installer.CreateRecord( 1 ) rec.IntegerData(1) = 30009 Session.Message &H01000000, rec

Displays the error message "Without the valid Product Key you can evaluate the product for 180 days. Click Back to enter the Product Key."

FIM Certificate Management Bulk Client Custom Actions

The following table is a list of custom actions that can be used when installing FIM Certificate Management Bulk Client.

Custom Action Custom Action Type Source Target Description

SetCustomUI

5

CA.JS

MsiSetCustomUIBlank

Does nothing

ShowDebugMsg

5

CA.JS

MsiShowDebugMsg

If running in Debug mode, creates a message box displaying installation/upgrade settings for the FIM CM Server

caValidateWebDir

5

CA.JS

MsiValidateWebDir

Validates that FIM CM IIS virtual directory doesn't already exist or is invalid

BackUpSettings

5

CA.JS

MsiBackUpBulkClient

Backs up FIM CM bulk Client configuration and remoting settings stored in registry keys

UpgradeSettings

5

CA.JS

MsiRestoreBulkClient

Restores FIM CM bulk client settings from backup.

BackupSmartcardappmgr

69

CA.JS

MsiBackupSmartcardAppMgr

Backs up Datacard printer plugins application settings

CheckDotNetVersion

8193

CMSetupUtl

CheckDotNetVersion

Validates that, at minimum, version 3.5 of the .NET framework is installed

ValidatePID

1

PIDCA

ValidateProductID

Checks whether a product has validated successfully by checking the ProductID property. The installer sets the ProductID property to the full product identifier after a successful validation.

RegisterDataCardPlugIn

50

REGASMPATH

[BIN]Microsoft.Clm.DataCardPlugIns.dll /silent /codebase

Invokes the Assembly Registration tool to register the FIM CM Datacard Plugin

UnRegisterDataCardPlugIn

114

REGASMPATH

[BIN]Microsoft.Clm.DataCardPlugIns.dll /silent /unregister

Invokes the Assembly Registration tool to unregister the FIM CM Datacard Plugin

RollbackRegisterDataCardPlugIn

1394

REGASMPATH

[BIN]Microsoft.Clm.DataCardPlugIns.dll /silent /unregister

Invokes the Assembly Registration tool to unregister the FIM CM Datacard Plugin

SxsInstallCA

1

SxsUninstallCA

CustomAction_SxsMsmInstall

Including the Visual Studio 2005 SP1 merge modules for the Visual C++ 8 Runtime in your installation package causes two Microsoft custom actions to be included in your installation package (SxsInstallCA and SxsUninstallCA). These custom actions contain additional logging and debugging logic that gets run automatically when the MsiLogging property value contains the "v" and "x" switches and can add SIGNIFICANT time to the install/uninstall process.

SxsUninstallCA

1

SxsUninstallCA

CustomAction_SxsMsmCleanup

Including the Visual Studio 2005 SP1 merge modules for the Visual C++ 8 Runtime in your installation package causes two Microsoft custom actions to be included in your installation package (SxsInstallCA and SxsUninstallCA). These custom actions contain additional logging and debugging logic that gets run automatically when the MsiLogging property value contains the "v" and "x" switches and can add SIGNIFICANT time to the install/uninstall process.

InvalidKeyErrorMsg

38

dim rec set rec = Session.Installer.CreateRecord( 1 ) rec.IntegerData(1) = 30007 Session.Message &H01000000, rec

Displays the error message "The product key is not valid."

EvalKeyErrorMsg

38

dim rec set rec = Session.Installer.CreateRecord( 1 ) rec.IntegerData(1) = 30009 Session.Message &H01000000, rec

Displays the error message "Without the valid Product Key you can evaluate the product for 180 days. Click Back to enter the Product Key."