Install, upgrade, and uninstall

Note:

To configure server high availability through load balancing, see Configure load balancing in an existing deployment and Deploy and load-balance Session Recording in Azure.

This article includes the following sections:

• Installation checklist

• Use Citrix scripts to install the Windows roles and features prerequisites

• Install the Session Recording administration components

  • Install the Session Recording database

  • Install the Session Recording server

• Install the Session Recording agent

• Install the Session Recording player and the web player

• Automate installation

• Upgrade Session Recording

• Uninstall Session Recording

• Integrate with Citrix Analytics for Security

Installation checklist

You install the Session Recording components by using the following files:

• Broker_PowerShellSnapIn_x64.msi

• SessionRecordingAdministrationx64.msi

• SessionRecordingAgentx64.msi

• SessionRecordingPlayer.msi

• SessionRecordingWebPlayer.msi

Before you start the installation, complete this list:

Note:

• We recommend that you divide the published applications into separate Delivery Groups based on your recording policies. Session sharing for published applications can conflict with the active policy if the applications are in the same Delivery Group. Session Recording matches the active policy with the first published application that a user opens. Starting with version 7.18, you can use the dynamic session recording feature to start or stop recording sessions at any time during the sessions. For more information, see Dynamic session recording.
• If you plan to use Machine Creation Services (MCS) or Citrix Provisioning, prepare a unique QMId. Failure to comply can cause recording data losses.
• SQL Server requires that you enable TCP/IP, the SQL Server Browser service is running, and Windows Authentication is used.
• To use HTTPS, configure server certificates for TLS/HTTPS.
• Make sure that users under Local Users and Groups > Groups > Users have write permission to the C:\windows\Temp folder.

Use Citrix scripts to install the Windows roles and features prerequisites

For Session Recording to work properly, use the following Citrix scripts to install the necessary Windows roles and features prerequisites before installing Session Recording:

• InstallPrereqsforSessionRecordingAdministration.ps1

   <#
   .Synopsis
       Installs Prereqs for Session Recording Administration
   .Description
       Supports Windows Server 2022, Windows Server 2019 and Windows Server 2016.
       Install below windows feature on this machine:
       -Application Development
       -Security - Windows Authentication
       -Management Tools - IIS 6 Management Compatibility
           IIS 6 Metabase Compatibility
           IIS 6 WMI Compatibility
           IIS 6 Scripting Tools
           IIS 6 Management Console
       -Microsoft Message Queuing (MSMQ), with Active Directory integration disabled, and MSMQ HTTP support enabled.
   #>
   function AddFeatures($featurename)
   {
       try
       {
           $feature=Get-WindowsFeature | ? {$_.DisplayName -eq $featurename -or $_.Name -eq $featurename}
           Add-WindowsFeature $feature
       }
       catch
       {
           Write-Host "Addition of Windows feature $featurename failed"
           Exit 1
       }
       Write-Host "Addition of Windows feature $featurename succeeded"
   }
  
   $system= gwmi win32_operatingSystem | select name
  
   if (-not (($system -Like '*Microsoft Windows Server 2022*') -or ($system -Like '*Microsoft Windows Server 2019*') -or ($system -Like '*Microsoft Windows Server 2016*')))
   {
       Write-Host("This is not a supported server platform. Installation aborted.")
       Exit
   }
  
   # Start to install Windows feature
   Import-Module ServerManager
  
   AddFeatures('Web-Asp-Net45') #ASP.NET 4.5
   AddFeatures('Web-Mgmt-Console') #IIS Management Console
   AddFeatures('Web-Windows-Auth') # Windows Authentication
   AddFeatures('Web-Metabase') #IIS 6 Metabase Compatibility
   AddFeatures('Web-WMI') #IIS 6 WMI Compatibility
   AddFeatures('Web-Lgcy-Scripting')#IIS 6 Scripting Tools
   AddFeatures('Web-Lgcy-Mgmt-Console') #IIS 6 Management Console
   AddFeatures('MSMQ-HTTP-Support') #MSMQ HTTP Support
   AddFeatures('web-websockets') #IIS Web Sockets
   AddFeatures('NET-WCF-HTTP-Activation45') #http activate
   <!--NeedCopy-->