Skip to content

Recording Profile

Overview

A Session Recording Profile is a set of settings and configurations used to record user session(s). The profile has multiple attributes that determine the recording behavior.

To enable session recording on the user session, associate the session recording profile with the connection profile.

  1. Recording can be done on the following User sessions.

    1. Application sessions
    2. Desktop session

  2. Recording can begin in the following way.

    1. On user logon
    2. On the launch of specific applications
    3. When a specific network IP Address is accessed
    4. Between specific intervals

  3. Recording can pause in the following way.

    1. When the user is idle for

Session Recording Profile can control the behavior of recording, like video format MKV/MP4, Frame rate, Recording visual, Scale (Resolution), Enable transcript, etc.
Session recording is supported only for Windows-based Applications and Desktop sessions.

Session Recording Profile can be managed from the HyWorks Controller Management Console

Policies > Profiles > Session Recording Profile

View the list of Session Recording Profiles

All session recording profiles are listed on the Policies > Profiles > Session Recording Profile page. On navigating to the Session Recording Profiles grid, the following column details can be seen:

  • Name: Showing the name of the session recording profile. Searching and sorting are available on this column.

  • Description: Showing description of the session recording profile. Searching and sorting are available on this column.

    The following UI actions are available for administrators for ease of administration:

  • Refresh: Re-fetching all information from the HyWorks Controller service for added session recording profiles.

  • Sorting: Clicking the column header sorts the session recording profile. Sorting is available by the columns Name and Description.

    • Default Sorting: By default, the profile is sorted by Profile Name only, so all Profiles are sorted alphabetically.

  • Search: Administrator can search for any specific profile by providing an appropriate search string. Clearing the search will start displaying the list of Profiles again.

  • Footer Control:

    • Goto Page: This control is used to go to a particular page located on the footer’s left side
    • Page Info: Displaying the number of items per page out of the total items shown in the footer center side
    • Pagination: A pagination control on the right side of the footer.

Session Recording Profile Attributes(Settings)

Recording Settings

Identify session recording profiles, start recording, pause recording, and notify the user of the settings in use.

  • Profile Name: Logical name of session recording profile.

  • Description: Logical description of session recording profile.

  • Start recording

    • On user logon: Session recording will start on user logon.

    • On the launch of specific applications: Session recording will start on the launch of the particular application. Multiple applications can be configured, using comma(",") separated values. (e.g., notepad, Chrome, Edge).

    • When a specific network IP address is accessed: Session recording starts. Multiple IP Addresses can be configured as comma-separated values (e.g., 192.27.10.10, 192.27.10.20, 192.27.10.10, 192.27.10.20,192.27.10.30).

    • Between specific intervals: The Session will be recorded between the specified time intervals

      • Time is displayed according to the end-user's time zone, as determined by the management console's access location. The specified time will be converted to UTC and will be recorded accordingly.

  • Pause recording

    • When user is idle for: Specify for how long the user's idle desktop or application sessions will be recorded. Minimum value is 60 sec (1 min), and maximum value is 43200 sec (12hrs)

  • Notify the user: Show a notification to the logged-in user to start session recording.

Configurations

These configurations control the recorder's behavior when recording a session.

  • Format: To select the format of recording. Currently supported formats are MKV and MP4 format.

  • Frame rate: The Default frame rate is set as 2.0 frames per second. Minimum value is 0.5 and maximum value is 1001000.

  • Recording visuals: To specify in which visuals the video needs to be recorded. Options are Color and Black & White.

  • Scale (Resolution): To set the resolution scale of recording. The Default Resolution scale is set as 800x600.

  • Raw data file path: The path '%PROGRAMDATA%\Accops\Session Recorder\Raw_output\' where recorded files of the user session will be kept on the desktop virtual machine.

  • Maximum recording length in minutes: For optimized processing of session recordings, the system stores them in small file chunks.

    • The length of the recording chunk is decided by:

      • Control 1: Maximum recording length in minutes (Configuration from Recording profile)
      • Control 2: Maximum file size (Available in Session Host/ DVM Agent Registry).

    • The default value for the Maximum Recording length in minutes is 15 minutes, a minimum of 5 minutes, and a maximum of 12 hours (i.e., 720 minutes). This setting defines the maximum duration for a single recording chunk.

    • Once this time or the max file size is reached (whichever comes first), the system will automatically start a new recording chunk.

  • Upload recording file: Upload session recording files to SRMS (Session Recording Management Server)

    • Upload immediately: After the recording file is created, it will upload immediately to the Session Recording Management Server.

    • Upload between specific intervals: After creating the recording file, it will upload to the Session Recording Management Server within the specified start and end times (in the browser's time zone). It will upload recording files within the given time range.

  • If recording cannot be done: Decide whether to allow or block desktop or application sessions if recording cannot be started.

    • Allow user session: If the Allow user session flag is set, the user can take the session, even if recording cannot be performed.

    • Block user session: If the Block user session flag is set, the user will not be allowed to take the session if recording cannot be done.

  • Hold logout until recording processed: Hold the user session logout until FFmpeg cleanup, so we can avoid video corruption on logout when enabling hold logout. Otherwise, don't hold the user logout. It is recommended to keep this flag enabled to avoid recording file corruptions.

  • Enable transcript: Enable subtitle file creation for the session recording. If this flag is disabled, then the recorder will not create the subtitle file.

  • Additional input parameters: Additional input parameter to handle session recording.

  • Additional output parameters: Additional output parameter to handle session recording.

Session Recording Management

Create a New Session Recording Profile

  1. Go to Policies > Profiles > Session Recording Profile

  2. Click Add

  3. Provide all the required details.

  4. Once all configurations are done, click on Save.

The new session recording profile will be added, and the Administrator can assign the profile to the Connection Profile.

Edit Session Recording Profile

  1. Go to Policies > Profiles > Session Recording Profile

  2. Select the recording profile and click Edit.

  3. Update the required configurations and click on Save

Delete Session Recording Profile

  1. Go to Policies > Profiles > Session Recording Profile

  2. Select the recording profile and click Delete.

  3. Click Delete, then confirm in the confirmation dialog.

Session Recording Profile will be deleted, and its entry will be removed from the grid.

Note

  • The session recording profile needs to be associated with the connection profile to enable session recording. Details are provided in Recording Configurations

When deleting, if the session recording profile is linked to any connection profiles, an error will appear and it won't be deleted until all references are fully removed.