Product Documentation

Install, upgrade, and uninstall Session Recording

Dec 06, 2016

Installation checklist

Before you start the installation, complete this list:  

Step
  Install the prequisites before starting the installation. See System Requirements and Use a script to add Windows roles and features prerequisites
  Select the machines on which to install each Session Recording component and ensure that each computer meets the hardware and software requirements for the component or components to be installed on it.
 

Download the Session Recording from the Citrix download page under 

XenApp > https://www.citrix.com/downloads/xenapp.html

or

XenDesktop > https://www.citrix.com/downloads/xendesktop.html

  If you use the SSL protocol for communication between the Session Recording components, install the correct certificates in your environment.
  Install any hotfixes required for the Session Recording components. The hotfixes are available from the Citrix Support
  Configure Director to create and activate Session Recording policies. For more information, see Configure Director to use the Session Recording Server.

Notes:

  • We recommend dividing the published applications into separate Delivery Groups based on the recording policies, because session sharing for published applications can conflict with active policies if they are in the same Delivery Group. Session Recording matches the active policy with the first published application that a user opens.
  • If you are planning to use Machine Creation Services (MCS) or Provisioning Services, prepare for a unique QMId; see the description in Known issues. Failure to do this step might result in lost recording data.
  • SQL server requires that TCP/IP is enabled, the SQL Server Browser service is running, and Windows Authentication is used.
  • If you want to use HTTPS, configure server certificates for TLS/HTTPS.

Session Recording installation files:

  • Session Recording Administration files
    • Broker_PowerShellSnapIn_x64.msi
    • SessionRecordingAdministrationx64.msi
  • Session Recording Agent files
    • SessionRecordingAgentx64.msi
    • SessionRecordingAgent.msi
  • Session Recording Player files
    • SessionRecordingPlayer.msi

Use a script to add Windows roles and features prerequisites

For Session Recording to work properly, you must add some Windows roles and features as prerequisites before installing the Session Recording components. Because you might have difficulty finding and installing some of the roles and features, this article contains a procedure using a Citrix-supplied script. Run the script to install the Windows roles and features prerequisites before the installation of Session Recording components.

To install Windows roles and features prerequisites

1.     If you want to you use the Citrix scripts, see Scripts for Windows roles and features prerequisites.

2.     Do the following on the machine on which you plan to install Session Recording Administration components:

a)     Make sure the execution policy is set to RemoteSigned or Unrestricted in PowerShell.

Set-ExecutionPolicy RemoteSigned

b)    Start a command prompt as an administrator and run this command:

powershell.exe -file InstallPrereqsforSessionRecordingAdministration.ps1

The script displays the features that are successfully added and then stops.

c)     After the scripts execute, ensure the execution policy is set to a proper value based on company policy.

3.     Do the following on the machine on which you plan to install the Session Recording Agent component:

a)     Make sure the execution policy is set to RemoteSigned or Unrestricted in PowerShell.

Set-ExecutionPolicy RemoteSigned

b)    Start a command prompt as an administrator and run this command:

powershell.exe -file InstallPrereqsforSessionRecordingAgent.ps1

The script displays the features that are successfully added and then stops.

c)     After the scripts execute, ensure the execution policy is set to a proper value based on company policy.

4.     After the Windows roles and features are installed, proceed with the Session Recording installation. 

Install Session Recording Administration components

The Session Recording Administration components are the Session Recording Database, Session Recording Server, and the Session Recording Policy Console. You can choose which of these components to install on a server.

Before installing the Session Recording Administration components, ensure you have all the prerequisites installed. See Session Recording system requirements.

To improve security, you can remove these permissions after installing the database.

  1. Run the Broker_PowerShellSnapIn_x64.msi and follow the instructions to complete the installation.
  2. Start the Windows command prompt as Administrator, and then run the command msiexec /i SessionRecordingAdministrationx64.msi or double-click the .msi file.
  3. On the installation UI, select Next and accept the license agreement.
  4. On the Session Recording Administration Setup screen, select the Session Recording Administration components you want to install.

Note

Session Recording Administrator Logging is an optional subcomponent under the Session Recording Server. Install this component if you want to enable the Administrator Logging feature. 

Install the Session Recording Database

Before installing the Session Recording Database, ensure you have all the prerequisites installed. See Session Recording system requirements.

Important: The Session Recording Database is not the actual database. It is the component responsible for creating and configuring the required databases in the Microsoft SQL Server instance during installation.

There are typically these three types of Session Recording Database components and Microsoft SQL Server deployments:

  • Deployment 1: Install the Session Recording Server and Session Recording Database on the same server and the Microsoft SQL Server on a remote machine. (Recommended)
  • Deployment 2: Install the Session Recording Server, Session Recording Database, and the Microsoft SQL Server on the same machine.
  • Deployment 3: Install the Session Recording Server on a server and install both the Session Recording Database and Microsoft SQL Server on the same machine but different than the Session Recording Server machine.(Not recommended).
  1. On the Database Configuration page:
    • Deployments 1 and 2: Type localhost in the Session Recording Server computer account field.
    • Deployment 3: Type the name of the computer hosting the Session Recording Server in the following format: domain\computer-name. The Session Recording Server computer account is the user account for accessing the database.
localized image

If the database instance is not a named instance as you configured when you set up the instance, you can use only the computer name of the SQL Server. If you have named the instance, use computer-name\instance-name as the database instance name. To determine the server instance name you are using, run select @@servername on the SQL Server; the return value is the exact database instance name. 

Click Test to test the connection to the SQL Server. Make sure the current user has the public SQL Server role permission; otherwise the test fails for permission limitation. Then click Next to continue the installation.

2.  Follow the instructions to complete the installation. During the installation, if the current user is not the database administrator, a dialog box prompts for the credentials of a database administrator with securityadmin and dbcreator server role permissions. Enter the correct credentials and then click OK to continue the installation.  The installation creates the new Session Recording Database and adds the machine account of the Session Recording Server as db-owner.

After the installation completes, the securityadmin and dbcreator server role permissions are no longer necessary and can be safely removed for the current user.

Important

You cannot change the CitrixSessionRecording database name. 

Install the Session Recording Server

Before installing the Session Recording Server, ensure you have all the prerequisites installed. See Session Recording system requirements.

  1. Enter the name of your SQL server in the Database Instance Name text box. If you are using a named instance, enter computer-name\instance-name; otherwise enter a computer-name only.
  2. Click Test to test the connection to the SQL server. Make sure the current user has the public SQL Server role permission; otherwise the test fails for permission limitation. Then click Next to continue the installation and follow the instructions to complete the installation.
  3. At the end of the installation wizard, you can choose to participate in the Citrix Customer Experience Improvement Program. When you join this program, anonymous statistics and usage information is sent to Citrix; for more information, see About the Citrix Customer Experience Improvement Program (CEIP).
  4. The Session Recording Server default installation uses HTTPS/TLS to secure communications. If TLS is not configured in the default IIS site of the Session Recording Server, use HTTP. To do so, deselect SSL in the IIS Management Console by navigating to the Session Recording Broker site, open the SSL settings, and uncheck the Require SSL box.

Configure Director to use the Session Recording Server

You can use the Director console to create and activate Session Recording policies.

  1. For an https connection, install the certificate to trust the Session Recording Server in the Trusted Root Certificates of the Director server.
  2. To configure the Director server to use the Session Recording Server, run the command: C:\inetpub\wwwroot\Director\tools\DirectorConfig.exe /configsessionrecording
  3. Enter the IP/FQDN of the Session Recording Server, the port number, and the connection type (http/https) from the Session Recording Agent to Session Recording Broker on the Director server.

Install the Session Recording Agent

The Session Recording Agent must be installed on the VDA or VDI machine on which you want to record sessions.

  1. Use the Server Manager to install .NET Framework and Microsoft Message Queuing (MSMQ) with HTTP support on the Server OS VDA or VDI machine.
  2. Start the Windows command prompt as Administrator, and then run the command: 
    msiexec /i SessionRecordingAgentx64.msi 
    or
    msiexec /i SessionRecordingAgent.msi

    or double click the .msi file.

    Use the correct .msi file based on platform type: SessionRecordingAgent.msi for 32 bit systems and SessionRecordingAgentx64.msi for 64 bit systems.
  3. On the installation UI, select Next and accept the license agreement.
  4. In the Session Recording Agent Configuration page, enter the name of the computer where you installed the Session Recording Server and the protocol and port information for the connection to the Session Recording Server.
localized image

  5. Follow the instructions to complete the installation.

Install the Session Recording Player

Install the Session Recording Player on the Session Recording Server or one or more workstations in the domain for users who view session recordings.

Run the SessionRecordingPlayer.msi and follow the instructions to complete the installation.

Automating installations

To install Session Recording Agent on multiple servers, write a script that uses silent installation.

The following command line installs the Session Recording Agent and creates a log file to capture the install information.

For 64 bit systems:

msiexec /i SessionRecordingAgentx64.msi sessionrecordingservername=yourservername sessionrecordingbrokerprotoco=yourbrokerprotocol  sessionrecordingbrokerport=yourbrokerport /l*v yourinstallationlog /q

For 32 bit systems:

msiexec /i  SessionRecordingAgent.msi sessionrecordingservername=yourservername sessionrecordingbrokerprotoco=yourbrokerprotocol sessionrecordingbrokerport=yourbrokerport /l*v yourinstallationlog /q

where:

yourservername is the NetBIOS name or FQDN of the computer hosting the Session Recording Server. If not specified, this value defaults to localhost.

yourbrokerprotocol is either HTTP or HTTPS, and represents the protocol that Session Recording Agent uses to communicate with Session Recording Broker; this value defaults to HTTPS if not specified.

yourbrokerport is an integer representing the port Session Recording Agent uses to communicate with Session Recording Broker. If not specified, this value defaults to zero, which directs Session Recording Agent to use the default port number for the selected protocol: 80 for HTTP or 443 for HTTPS.

/l*v specifies verbose mode logging

yourinstallationlog is the location of the setup log file created.

/q specifies quiet mode.

Upgrade Session Recording

You can upgrade certain deployments to newer versions without having to first set up new machines or sites. You can upgrade from Session Recording 7.6.0 (or a later version) to the latest released (current) Session Recording version.

Requirements, preparation, and limits

Note: You cannot upgrade from a Technology Preview version.

  • You must use Session Recording installer's graphical or command-line interface to upgrade Session Recording components on the machine where you installed corresponding Session Recording components.
  • Before beginning any upgrade activity, back up the database named CitrixSessionRecording in the SQL Server instance, so you can restore it if any issues are discovered after the database upgrade.
  • In addition to being a domain user, you must be a local administrator on the machines where you are upgrading the Session Recording components.
  • If Session Recording Server and Session Recording Database are not installed on the same server, you must have the database role permission to upgrade Session Recording Database; otherwise, you are asked for securityadmin and dbcreator role credentials during the upgrade.
  • If you do not plan to upgrade all the Session Recording Agents at the same time, Session Recording Agent 7.6.0 (or a later version) can work with the latest released (current) Session Recording Server. However, some new features and bug fixes might not take effect.
  • Any sessions launched during the upgrade of Session Recording Server are not recorded.
  • The Administrator Logging feature is not installed after you upgrade Session Recording from a previous release that doesn't contain this feature. To add this new feature, modify the installation after the upgrade.
  • If there are live recording sessions when the upgrade process starts, there is very small chance the recording cannot be completed.
  • Review the upgrade sequence below so you can plan and mitigation potential outages.

Upgrade sequence

  1. If Session Recording Database and Session Recording Server are installed on different servers, stop the Session Recording Storage Manager service manually on Session Recording Server, and then upgrade Session Recording Database first.
  2. Ensure Session Recording Broker is running with IIS service. Upgrade Session Recording Server. If Session Recording Database and Session Recording Server are installed on the same server, Session Recording Database will also be upgraded.
  3. Session Recording service is back online automatically when the upgrade of Session Recording Server is completed.
  4. Upgrade Session Recording Agent (on master image).
  5. Upgrade Session Recording Policy Console with or after Session Recording Server.
  6. Upgrade Sessoin Recording Player.

Uninstall Session Recording

To remove Session Recording components from a server or workstation, use the uninstall or remove programs available through the Windows Control Panel. To remove the Session Recording Database, you must have the same securityadmin and dbcreator SQL server role permissions as when you installed it.

For security reasons, the Administrator Logging database is not removed after the components are uninstalled .