Jump to content

POC Guide: Citrix Session Recording

  • Contributed By: Steve Beals Special Thanks To: Leon Feng


This Proof of Concept guide is designed to help you quickly set up and configure Citrix Session Recording and the Citrix Session Recording Service. At the end of this Proof of Concept guide, you can record and play back user sessions from both on-premises and Citrix Cloud.

Conceptual Architecture


All Citrix Session Recording components reside in your secure resource location. The Session Recording agents are installed on either a single-session OS, multi-session OS, or Remote PC Access VDA. The Session Recording Server and the Session Recording Policy Console are installed on separate Windows servers. The Session Recording Player is installed on a workstation. The Session Recording Agent, policy console, player, and database communicate with the Recording Server. End-user devices with the Citrix Workspace app connect to the Citrix VDA, where the Session Recording Agent is installed.


In this Proof of Concept guide, you experience the role of a Citrix DaaS administrator and set up Citrix Session Recording within your on-premises Citrix DaaS resource location. You will optionally set up the Citrix Session Recording Service and connect your on-premises Session Recording servers to this service.

This guide showcases how to perform the following actions:

  1. Install the Session Recording administration components in your Resource Location.
  2. Install the Session Recording Agent on the VDA machine.
  3. Connect the Session Recording servers to the Session Recording Service.
  4. Create a Session Recording policy.
  5. Replay a recording with the on-premises and cloud-hosted Session Recording player.


All Session Recording server components are installed on a single server for this proof-of-concept. For production environments, Citrix recommends that each component resides on separate servers. This proof of concept requires the following:

  1. An existing on-premises Citrix Virtual Apps and Desktops or Citrix DaaS Resource location.
  2. Download the Citrix Virtual Apps and Desktops v2209 Product ISO from citrix.com.
  3. Create one Windows 2019 Server within your Resource Location with Microsoft SQL Server 2019 Express Edition installed.
  4. Create one Windows VDA within your Resource Location. This VDA can either be a Windows Server or Desktop VDA.

Install Session Recording Components

The first step is to install all of the Citrix Session Recording components required on the Windows 2019 server you have created.

  1. Connect to the Windows 2019 server (for this POC, we connect via RDP)


  2. Mount Citrix Virtual Apps and Desktops Product ISO and run AutoSelect. Click Start for Virtual Apps and Desktops


  3. Click Session Recording


  4. Accept the terms of the license agreement, then Click Next


  5. Select Session Recording Administration and Session Recording Player then Click Next


  6. Select all Features and Click Next


  7. Enter your SQLEXPRESS Instance Name, leave the Database Name to default, and click Test connection. Once the Test is confirmed, enter your Session Recording Server computer account name, then Click Next.


  8. Click Test connection Once the test passes, Click Next.


  9. Review the Summary screen, then Click Install


  10. The machine will require a restart after the prerequisites are installed. Select Close and allow the server to reboot.


  11. Once rebooted, connect back to the server. Session Recording continues to install.


  12. Once the Session Recording install completes, Click Finish


    The Session Recording server components are now installed.

Install Session Recording Agent

The next step is installing the Session Recording Agent on the Windows VDA used in this POC.

  1. Connect to your Windows VDA (for this POC, we connect via RDP).


  2. Mount Citrix Virtual Apps and Desktops Product ISO and run AutoSelect. Click Start for Virtual Apps and Desktops

  3. Click Session Recording


  4. Accept the terms of the license agreement, then Click Next


  5. Select Session Recording Agent, then Click Next


  6. Enter the Session Recording server name, change Protocol to HTTP, then Click Text Connection. Once the test completes, Click Next.


  7. Review the Summary page, then Click Install.


  8. The Session Recording Agent begins to install.


  9. Once the Session Recording Agent install has been completed, Click Finish.


The Session Recording Agent is now installed on your Windows VDA.

Add the Windows VDA to a new Machine Catalog and Delivery Group

Add the Windows VDA to a new Machine Catalog and Delivery Group within your Citrix Virtual Apps and Desktops or Citrix DaaS console.

Connect Session Recording Server to Citrix Cloud (Optional)

The Session Recording service provides an advanced administration experience and simplifies deployment. It supports centralized management of server settings, policies, and playback. The Session Recording service facilitates administrative tasks by providing a unified entry point to manage and observe the Session Recording servers across your organization. The optional next step is connecting the Session Recording server that you created to the Session Recording service. Before beginning these steps, ensure that Ports 8088 and 9090-9094 are open outbound for the Session Recording Server.

  1. On your Session Recording Server, Log on to Citrix Cloud


  2. Click Manage in the Citrix DaaS tile


  3. Select Manage > Session Recording


  4. Select Configuration > Server Management from the left navigation menu.


  5. Select Create Site


  6. Enter the Site name and optional Description, then Click Save.


  7. Click the Server connection guide link to begin the process of adding your Session Recording Server to the service.


  8. Download the Session Recording cloud client software. Click Download


  9. To communicate with Citrix Cloud, you need to create a Secure Client for the Session Recording cloud. To configure this, open Identity and Access Management from the top left hamburger menu.


  10. Select API Access


  11. Copy your customer ID parameter to Notepad.


  12. Enter a name in the Name your Secure Client input box, and Click Create Client


  13. Copy both your ID and Secret and paste them to Notepad. Then Click Download, then Close.


  14. The Session Recording POC Secure Client is now in your Secure Client list.


  15. Open Command Prompt and run the following command: msiexec /i SRCloudClientService.msi CUSTOMERID="<Citrix Cloud customer ID>" CLIENTID="<secure client ID>" CLIENTSECRET="<secure client secret>" /qn+

  16. Once the Session Recording cloud client install completes, Click OK.


  17. Return to Citrix Cloud Session Recording Service console, and Select Continue configuration.


  18. Your Session Recording Server is connected to the Citrix Cloud Session Recording service.


Configure and Enable Session Recording Policy

Once the Session Recording Server and Agent install are complete, you can now configure and enable the Session Recording policy.

Enable Session Recording on VDA

  1. On the Windows VDA, open Session Recording Agent Properties from the Start Menu.


  2. Select Enable session recording for this VDA machine, then Click Next. Choose Yes when prompted for a service restart.


Configure Session Recording Server

  1. Connect to the Session Recording server via RDP

  2. Open Session Recording Server Properties from the Start Menu


  3. Click Add for File storage directories, then Click Browse.


  4. Browse to C:/SessionRecordings, then Click OK.


  5. Select OK


  6. Select OK


  7. Select Yes if prompted to restart the Citrix Session Recording Storage Manager service.

Configure Session Recording Policy

  1. Open the IIS Manager on the Session Recording Server. Once open, select Sites > Default Web Site > SessionRecordingBroker, then Open SSL Settings.


  2. Clear Require SSL and Click Apply.


  3. Close ISS Manager, then restart the IIS server.

  4. Open the Session Recording Policy Console. Change Protocol to HTTP, then Select OK.


  5. When the Session Recording Policy Console opens, on the left navigation menu, Right-click on Recording Policies and Select Add New Policy.


  6. Right-click on the New Policy created and Select Add Rule


  7. Select Enable session recording with notification, and Click Next.


  8. Click OK at the warning message.


  9. Select Users or Groups, then Click Select Users or Groups in the Edit the rule criteria input box.


  10. Click Add


  11. Type the name of the AD User or Group, Select Check Names, then Click OK. (For our example, we are using a test user account we have created.)


  12. Click OK


  13. Click Next


  14. Provide a name and description for the rule, ensure that Enable this rule is selected, then Click Finish.


  15. Right-click on New Policy and Select Activate Policy.


Your Session Recording Policy is now active.

Launch a VDI Session

  1. Launch the Windows VDA session as the user that you have added to the Session Recording Policy. A prompt notifies the user that the session is recorded. Quickly open an application, then log off the session.


Playback Session Recording (Session Recording Server)

  1. Open Session Recording Player from the Start Menu.


  2. On the Toolbar, select the timeframe dropdown and select In last 24 hours, then click the Binoculars icon. Find the recording of the session you just launched in the list. Select the recording file and right-click on the file and select Play.


  3. Your recorded session will now play as seen below:


Playback Session Recording (Session Recording service)

  1. Log into Citrix Cloud and go to Session Recording Service Console. Select Recordings then All Recordings


  2. Click the Play button on your new recording to play back your session.



This guide walked you through setting up a Citrix Session Recording Server and connecting it to the Citrix Session Recording Service. You learned how to create a Session Recording policy and playback your recorded sessions. To learn more about Citrix Session Recording and the Session Recording service, visit the following:

Citrix Session Recording

Citrix Session Recording Service

User Feedback

There are no comments to display.

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Create New...