Product Documentation

Install, upgrade, and uninstall Session Recording

Feb 28, 2017

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 you want 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 package 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 TLS 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 the Session Recording policies. For more information, see Configure Director to use the Session Recording Server.

Notes:

  • Citrix recommends that you divide the published applications into separate Delivery Groups based on your 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 a unique QMId. For more information, see Known issues. Failure to comply can cause recording data losses.
  • SQL Server requires that TCP/IP is enabled, the SQL Server Browser service is running, and Windows Authentication is used.
  • 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 difficulties in finding and installing some of the roles and features, this article contains a procedure using a Citrix script. Run the script to install the Windows roles and features prerequisites before installing the Session Recording components.

To install Windows roles and features prerequisites

1.     If you want to 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 the Session Recording Administration components:

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

Set-ExecutionPolicy RemoteSigned

b)    Start a command prompt as an administrator and run the powershell.exe -file InstallPrereqsforSessionRecordingAdministration.ps1 command.

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

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

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

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

Set-ExecutionPolicy RemoteSigned

b)    Start a command prompt as an administrator and run the powershell.exe -file InstallPrereqsforSessionRecordingAgent.ps1 command.

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 the Session Recording Administration components

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

Before installing the Session Recording Administration components, ensure that you have all the prerequisites installed. For more information, see System requirements.

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

  1. Double-click Broker_PowerShellSnapIn_x64.msi and follow the instructions to complete the installation.
  2. Start the Windows command prompt as an administrator, and then run the msiexec /i SessionRecordingAdministrationx64.msi command or double-click the .msi file.
  3. On the installation UI, click 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 that you have all the prerequisites installed. For more information, see System requirements.

Important: Session Recording Database is not an actual database. It is a component responsible for creating and configuring the required databases in the Microsoft SQL Server instance during installation. Session Recording supports three solutions for database high availability based on Microsoft SQL Server. For more information, see Install Session Recording with database high availability.

There are typically three types of the 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 and Server 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 format of 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. 

Type a custom database name in the Database name text box or use the default database name by selecting Use default database name. Click Next to test the connectivity to the SQL Server instance and the validity of the database name.

Important

A custom database name must contain only A-Z, a-z, and 0-9, and cannot exceed 123 characters.

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 the 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.

Install the Session Recording Server

Before installing the Session Recording Server, ensure that you have all the prerequisites installed. For more information, see System requirements.

  1. Enter the name of your SQL Server in the Instance name text box. If you are using a named instance, enter computer-name\instance-name; otherwise enter a computer-name only. 
  2. Type a custom database name in the Database name text box or use the default database name by selecting Use default database name.
  3. Make sure that you have the public role permission to SQL Server and enter a correct database name. Then click Next to continue the installation and follow the instructions to complete the installation.
  4. On the next page, if you choose to install the Session Recording Administrator Logging feature, type a custom database name for the Administrator Logging Database in the Logging database name text box or use the default database name by selecting Use default database name.
  5. 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).
  6. 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, cancel the selection of SSL in the IIS Management Console by navigating to the Session Recording Broker site, opening the SSL settings, and clearing the Require SSL check 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 C:\inetpub\wwwroot\Director\tools\DirectorConfig.exe /configsessionrecording command.
  3. Enter the IP address or FQDN of the Session Recording Server and the port number and connection type (HTTP/HTTPS) that Session Recording Agent uses to connect 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 VDA for Server OS or VDI machine.
  2. Start the Windows command prompt as an administrator and run the msiexec /i SessionRecordingAgentx64.msi or msiexec /i SessionRecordingAgent.msi command or double-click the .msi file.
    Use the correct .msi file based on your platform type: SessionRecordingAgent.msi for 32-bit systems and SessionRecordingAgentx64.msi for 64-bit systems.
  3. On the installation UI, click Next and accept the license agreement.
  4. On 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.

Double-click SessionRecordingPlayer.msi and follow the instructions to complete the installation.

Automate 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 installation 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 HTTP or HTTPS that Session Recording Agent uses to communicate with Session Recording Broker. If not specified, this value defaults to HTTPS.

yourbrokerport is the port number that 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 your selected protocol: 80 for HTTP or 443 for HTTPS.

/l*v specifies verbose logging.

yourinstallationlog is the location of your installation log file.

/q specifies the quiet mode.

Upgrade Session Recording

You can upgrade certain deployments to later versions without having to first set up new machines or sites. You can upgrade from Session Recording 7.6.0 (or later) to the latest release of Session Recording.

Requirements, preparation, and limitations

Note: You cannot upgrade from a Technology Preview version.

  • You must use the Session Recording installer's graphical or command-line interface to upgrade the Session Recording components on the machine where you installed the components.
  • Before beginning any upgrade activity, back up the database named CitrixSessionRecording in the SQL Server instance, so that 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 the 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 later) can work with the latest (current) release of 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 little chance that the recording can be completed.
  • Review the upgrade sequence below, so that you can plan and mitigate 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 that 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 the Session Recording components from a server or workstation, use the uninstall or remove programs available through the Windows Control Panel. To remove 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.