Skip to main content
Skip table of contents

Screen Recording for Cisco Configuration and Deployment Guide

Pre-Requisite

  1. Voice Recording Solution should be deployed on a Server.

  2. An SFTP server is required which is same as where VRS is deployed.

  3. This SFTP server must be configured for the root user.

Deployment and Configuration of Screen Recording Service

For screen recording service follow the below:

A) SFTP server configuration

  1. Configure SFTP on VRS server on root user.

  2. Note the SFTP root password.

  3. Note the SFTP IP Address.

B) Finesse Server Gadget Deployment

  1. Gadget file to be deployed is FinesseGadgetApi.zip download.

  2. Unzip the finessesGadgetApi.zip

  3. From you host Machine navigate to the Gadget Directory in terminal or sftp software.

  4. Connect to the Finesse host using the following command: sftp 3rdpartygadget@<finesse.ip> (Replace finesse.ip with IP address)

  5. If it prompts for a password, put in the password for the 3rdpartygadget user.

  6. Once connected to the finesse machine, use cd files command to navigate into the files folder.

  7. Once you are in the files folder, use the command put -r <foldername> to copy folders. Replace foldername with FinessesGadget.

  8. Once files are copied, log in to https://<finesse.ip>:8445/cfadmin . Replace finesse.ip with you finesse ip or FQDN.

  9. Click on Team Resources, click on a team, and edit the text that describes the Finesse desktop. Locate <role>agent</role>.

  10. Locate the <id>home</id> in the agent role

  11. Add the line in the <gadgets> tab as show in image. <gadget>/3rdpartygadget/files/FinessesGadgetApi/ScreenRecordingGadget.xml</gadget>.

image-20251127-171435.png

Example Adding Gadget for Agent

  1. Repeat the above steps for the supervisor role (if the screen recording is required for the supervisor).

image-20251127-172107.png

Example Adding Gadget for Supervisor

  1. Login to the UCCX/UCCE Administration. Cisco U

  2. From menu bar open Subsystems → Rmcm → Teams

  3. Open your team and add the Agents (on which recording is to be enabled) in the Assigned Resources Section.

C) Agent Computer

The agent workstation includes two user accounts. One account is intended for administrative or supervisory use, while the second account is designated for the agent. The actual account names may differ from “admin” or “agent” depending on the deployment environment.

  1. Log into Admin account (Remember: This is the primary workstation account managed by the administrator or supervisor, and its name may vary based on the deployment)

  2. Download the Screen Recording executable file from here Controller.exe .

  3. Download config-admin.ps1 file.

  4. Download config-agent.ps1

  5. Download ffmpeg.zip and

  6. Unzip ffmepg.zip folder and copy the ffmpeg file from the folder.

  7. Create a folder named "Service" in the C: drive and place the following files inside it:

    • Controller.exe

    • config-admin.ps1

    • config-agent.ps1

    • ffmpeg.exe

  8. Right click on the Service folder and go to properties.

  9. In properties go to Security section.

  10. Click Edit button to change permissions.

  11. Click Add to add Admin and Agent Account.

  12. Name of account can be found in command prompt using the command whoami as shown in the image

image-20251209-111703.png
  1. Type the name of the Admin user account and press check Names (Do not confuse it with Administrator Account which already exists in the list)

  2. Upon press check names button, a name will appear e.g DESKTOP-FPCJMEG\EF.

image-20251209-105103.png

Example

  1. Press Ok

  2. Now, Grant full permission (Full Control, Modify, Read, Read & execute, special permission) in the below section to the Admin account.

  3. Repeat the same steps for the Agent Account as well.

  4. Grant all permission except full control and special permission to the Agent account

  5. Press Ok.

  6. Go to Advanced option in the security tab.

  7. Double click on the Agent account.

  8. Press ' Show advance permissions' . Make sure Delete is unchecked.

  9. Open the command prompt in administrator mode or run as administrator.

  10. Add the required Environment Variables in the Command Prompt using the following syntax:

    CODE
    setx "<Environment Variable>" <Value> /M

    Refer to the table below for the necessary variables and their corresponding values.

Environment Variables

Value

AGENT_HOST

localhost

SFTP_IP

The IP address of the SFTP server, which is the same as the one where VRS is deployed

SFTP_ROOT_PASSWORD

Password of the SFTP Server

  1. Once done, close the command prompt and reopen. Verify that environment variables are saved by running the following command:

  2. echo %<Environment Variable>%

  3. Open PowerShell as Administrator and run the following commands on any path:

    1. Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

    2. Set-ExecutionPolicy Unrestricted -Scope CurrentUser

  4. A message will appear. Write yes and press enter.

  5. Run the power shell in administrator mode

  6. In PowerShell navigate to C:\Service\ using this command cd C:\Service\

  7. Run the config-admin.ps1 using command. .\config-admin.ps1

  8. If powershell asks permission to run it then type 'R' and run this command

  9. Run the config-agent.ps1 using command. .\config-agent.ps1

  10. Press windows button and type Task Scheduler.

  11. In the left most section click on Task Scheduler Library which is under Task Scheduler (local)

  12. All Libraries will open in the middle section

  13. At the bottom two task with name Service and Service-agent are now created.

  14. Double Click the Service task.

  15. A dialog box will appear.

  16. In the security option section make sure you have your account set under 'When running the task, use the following user account'

  17. Make sure 'Run only when user is logged on' option is checked

  18. Make sure ‘Run with the highest privileges’ option is checked

  19. Press Ok.

  20. Double Click the Service-agent task

  21. Under security option add the agent account.

  22. Click on the 'Change User or Group'

  23. Enter the name of the agent account. Press Check Names.

  24. Name of the agent account will appear. eg DESKTOP-FPCJMEG\EF2

  25. Press OK.

  26. Single click the Service task and In the right most section press Run.

  27. Do the same for Service-agent.

  28. Close the task scheduler.

  29. Go to the C Drive where the Service folder is located, and manually run Controller.exe by double-clicking it.

  30. Open the Browser and access this URL http://localhost:8000 . A page would open indicating that service is running fine.

  31. Now, make a test call. Upon transferring the file to the SFTP server, a folder named screen_recording will automatically be created in the root directory

  32. Access the server via SSH and log in to the SFTP server.

  33. Go to the /screen_recording Directory on the SFTP server and Verify if your recording is being saved.

  34. Download and Play the video manually.

    1. https://<SFTP_IP>/vrs/recording/screen/<filename.extension>

  35. Login to the VRS Application and Play the video button of the Call Activity

ffmpeg.exe Controller2.exe

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.