Product Documentation

Log insertion of USB mass storage devices

Feb 26, 2018

As of the 7.17 release, Session Recording can log the insertion of a Client Drive Mapping (CDM) mapped or generic redirected USB mass storage device in a client device where Citrix Receiver for Windows or for Mac is installed, and can tag the event in the recording. With this feature, you can easily search for events of interest from large amounts of recordings and can locate the events during playback in the Session Recording Player.

Note

Currently, only the insertion of USB mass storage devices (USB Class 08) can be logged. To make the feature work as expected, upgrade both Session Recording and the VDA to Version 7.17 or later.

Enable or disable the logging feature

On the Session Recording Agent, three registry keys are added for enabling or disabling the feature. The keys are set to 0 by default, which means the feature is disabled by default. 

To enable or disable the feature, do the following:

  1. After the Session Recording installation is complete, log on as an administrator to the machine where you installed the Session Recording Agent.
  2. Open the Registry Editor.
  3. Browse to HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\SmartAuditor\SessionEvents.
  4. Set the value of EnableSessionEvents to 1 or use the default value, 0.
    1: enable event logging globally
    0: disable event logging globally
  5. Set the value of EnableCDMUSBDriveEvents to 1 or use the default value, 0.
    1: enable logging the insertion of CDM mapped USB mass storage devices
    0: disable logging the insertion of CDM mapped USB mass storage devices
  6. Set the value of EnableGenericUSBDriveEvents to 1 or use the default value, 0.
    1: enable logging the insertion of generic redirected USB mass storage devices
    0: disable logging the insertion of generic redirected USB mass storage devices
  7. Restart the Session Recording Agent to make your settings take effect.
  8. (Optional) In Citrix Studio, configure the CDM mapping policy (enabled by default) and the USB redirection policy (disabled by default) as required.

The table below describes the usage scenarios and the corresponding registry key settings.

Scenario

Registry Key Setting

To log the insertion of both CDM mapped and generic redirected USB mass storage devices

EnableSessionEvents = 1

EnableCDMUSBDriveEvents = 1

EnableGenericUSBDriveEvents = 1

To log the insertion of only CDM mapped USB mass storage devices

EnableSessionEvents = 1

EnableCDMUSBDriveEvents = 1

EnableGenericUSBDriveEvents = 0

To log the insertion of only generic redirected USB mass storage devices

EnableSessionEvents = 1

EnableCDMUSBDriveEvents = 0

EnableGenericUSBDriveEvents = 1

To disable event logging globally

EnableSessionEvents = 0

EnableCDMUSBDriveEvents = 0

EnableGenericUSBDriveEvents = 0

Warning

Incorrectly editing the registry can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

Play back recordings with tagged events

When you play back a recording with events tagged for the insertion of mass storage devices, the events are present in the Events and Bookmarks panel and show as yellow dots in the lower part of the Session Recording Player as follows:

localized image

You can use events to navigate through a recorded session, or skip to the points where the events are tagged. 

Search for recordings with tagged events

The Session Recording Player allows you to perform advanced searches for recordings with tagged events.

  1. In the Session Recording Player, click Advanced Search on the tool bar or choose Tools  Advanced Search
  2. Define your search criteria in the Advanced Search dialog box.
    The Events tab allows you to search, by Event type, for tagged events in sessions. You can use the Common, Date/Time, and Event type filters in combination to search for recordings that meet your criteria. For example, you can search for recordings with the insertion events of CDM mapped USB mass storage devices within 24 hours.
localized image

Note

The Event type drop-down list itemizes all event types that have been logged by Citrix Session Recording. You can select any one of the event types to search. Selecting Any Citrix-defined event means to search for all recordings with any type of events logged by Citrix Session Recording.