Product Documentation

Upgrade web components

Jun 05, 2015
Updated: 2014-08-14

This topic describes the upgrade process of web components from Services Manager 11 to Services Manager 11.5. For upgrades, the term web components refers to the control panel web site, the API service, and all supported web services.

Prepare for the upgrade

During the upgrade process, the Services Manager Setup Tool updates all sites to run from the backup and puts all associated sites and application pools in a stopped state. Therefore, if the names of any of the sites or application pools in your deployment have been changed from the default, you must specify those changes in an XML file before you initiate the upgrade. To create this file, use the following format:
<Configuration>   <Property Name="<service-id>.ApplicationPool" Value="MyAppPool" />   <Property Name="<service-id>.Application" Value="MyAppName" />   <Property Name="<service-id>.Site" Value="MySite" /> </Configuration>

The service-id property is the web service's deployment identifier used in the Configuration Tool.

After creating the XML file, you can initiate the upgrade using the following command:
CortexSetup.exe /ConfigFile:path-to-XML-file /Upgrade

What happens during the upgrade

When you upgrade the web components, the Configuration Tool performs the following tasks:
  1. Stop the site and applicable web services in IIS.
  2. Back up the site. The default file path for this backup is %ProgramData%CitrixCloudPortal Services Manager SetupBackupsLegacycomponent-name.
  3. Update physical paths in IIS to point to the site backup.
  4. Update the site files in the %ProgramFiles% directory.
  5. Copy updated site files from %ProgramFiles% to C:Inetpubsite-name.
  6. Restore customer content from site backup (for example, downloads, images, stylesheets, or scripts).
  7. Restore web.config file from site backup and apply updates.
  8. Imports and saves the Encryption Service key.
  9. Update physical paths in IIS.
  10. Restart site in IIS.

Troubleshooting conflicts

In the event a conflict arises during the upgrade, the sites remain in a stopped state and reference the backup created earlier in the process. Site files in the %ProgramFiles% directory are updated and site content in C:Inetpubcomponent-name are reverted to the previous version. You can then review the configuration update file located in %ProgramFiles% and make any necessary changes to the deployed web.config file.

Instructions for upgrading

For instructions to upgrade web components, see Upgrade web services using the graphical interface or command line.