Product documentation
Session Recording
Service Current Release 2402 LTSR 2311 2308 2305 2303 2212 2210 2209 2207 2206 2204 2203 LTSR 2201 1912 LTSR 7.15
View PDF

Enable or disable recording

March 1, 2022
Contributed by: 
L

You install the Session Recording agent on multi-session OS VDAs for which you want to record sessions. Within each agent is a setting that enables recording for the VDA on which it is installed. After recording is enabled, Session Recording evaluates the active recording policy that determines which sessions are recorded.

We recommend you disable session recording on VDAs that are not recorded because there is a small impact on performance, even if no recording takes place.  

Enable or disable recording on a VDA

  1. Log on to the server where the Session Recording agent is installed.
  2. From the Start menu, choose Session Recording Agent Properties.
  3. Under Session Recording, select or clear the Enable session recording for this VDA machine check box to specify whether sessions can be recorded for this VDA.
  4. When prompted, restart the Session Recording agent service to accept the change.

Note:

When you install Session Recording, the active policy is Do not record (no sessions are recorded on any server). To begin recording, use the Session Recording policy console to activate a different policy.

Enable custom event recording

Session Recording allows you to use third-party applications to insert custom data, known as events, to recorded sessions. These events appear when the recorded session is played back. Events are part of the recorded session file and can’t be modified after the session is recorded.

For example, an event might contain the following text: “User opened a browser.” Each time a user opens a browser during a session being recorded, the text inserts to the recording at that point. When a viewer plays back the recorded session, the viewer can locate and count the times that the user opened a browser by noting the number of markers.

To insert custom events to recordings on a server:

  • Use Session Recording Agent Properties to enable a setting on each server where you want to insert custom events. Enable each server separately. You can’t globally enable all servers in a site.
  • Write applications built on the Event API that runs within each user’s Citrix Virtual Apps and Desktops session (to inject the data into the recording).

The Session Recording installation includes an event recording COM application (API) that allows you to insert text from third-party applications to a recording. You can use the API from many programming languages including Visual Basic, C++, or C#. For more information, see the Knowledge Center article CTX226844. The Session Recording Event API .dll is installed as part of the Session Recording installation. You can find it at C:\rogram Files\Citrix\SessionRecording\Agent\Bin\Interop.UserApi.dll.

To enable custom event recording on a server, do the following:

  1. Log on to the server where the Session Recording agent is installed.
  2. From the Start menu, choose Session Recording Agent Properties.
  3. In Session Recording Agent Properties, click the Recording tab.
  4. Under Custom event recording, select the Allow third party applications to record custom data on this server check box.
Enable or disable recording
March 1, 2022
Contributed by: 
L
March 1, 2022
Contributed by: 
L

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.