Product Documentation

Install Session Recording

Jan 05, 2016

Installation checklist

Before you start the installation, complete this list:

Step
  Install the prequisites before starting the installation. See System Requirements.
  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 zip file from the Citrix download page under XenApp > Components.
  If you use the TLS protocol for communication between the Session Recording components, install the correct certificates in your environment. See Install certificates.
  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.

Notes:

  • Citrix recommends 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 with XenApp, prepare the server 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
  • Session Recording Player files
    • SessionRecordingPlayer.msi

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 Administration components.

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.

Install the Session Recording Database

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

  1. On the Database Configuration page:
    • If you are installing all the Administration components on the same server, type localhost in the Session Recording Server Name field.
    • If you are installing the Session Recording Server and the Session Recording Database on different servers, type the name of the computer hosting the Session Recording Server in the following format: domain\machine-name. The Session Recording Server name 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 machine name of the SQL Server. If you have named the instance, use machine-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 sysadmin server role permission. 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.

Install the Session Recording Server

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

  1. Enter the name of your SQL server in the Database Instance Name text box. If you are using a named instance, enter machine-name\instance-name; otherwise enter a machine-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).

Install the Session Recording Agent

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

  1. Use the Server Manager to install .NET Framework 3.5 and Microsoft Message Queuing (MSMQ) with HTTP support on the Windows Server OS VDA.
  2. Start the Windows command prompt as Administrator, and then run the command msiexec /i SessionRecordingAgentx64.msi or double-click the .msi file.
  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

The Session Recording default installation uses HTTPS/TLS to secure communications. If TLS is not configured, 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.

  5.  If you want to use the Rollover feature, ensure that you install this hotfix: http://support.citrix.com/article/CTX142037.

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

Upgrade Session Recording

To upgrade Session Recording from an earlier release, run the installer on the machine where you installed corresponding Session Recording features.

Follow the instructions to finish the upgrade installation. You do not need to provide any information during the upgrade process. 

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 sysadmin SQL server role permissions as when you installed it.

Configure Director to use the Session Recording Server

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