Knowlege base

Screen Recording Engine setup

Article ID: 949
Last updated: 17 Nov, 2023

Starting from Imagicle 2023.Winter.1 UC Suite release, a new Screen Recording add-on is available for Imagicle Call Recording application.

This add-on allows voice recording-enabled users to capture their screen activity during an ongoing call. Once call is ended or recording is stopped, a video file is saved and available to download from Call Recording Search and Play web page.

Requirements

  • Imagicle UC on-prem or hosted UC Suite ver. 2023.Winter.1 or above. UC Cloud Suite: coming soon!
  • Users must be enabled for Imagicle Call Recording using Built-in Bridge, Network-based recording, Automated Dial-in conference, manual dial-in conference or SIPREC technologies. Mode info here.
  • Screen Recording is currently not available for Microsoft Teams environments: coming soon!
  • Screen Recording users or channels-based license should be available, matching or lower than existing Call Recording license
  • For enabling up to 1,000 concurrent screen recordings, you need to assigned 2 additional CPU/vCPU cores and 1GB additional RAM. For higher volumes of concurrent screen recordings, please contact Imagicle team.
  • HDD size must be raised, to store the required amount of screen recording video files, for the required retention period. Imagicle provides a Storage Calculator for this purpose.

Screen Recording Engine - Server components

Imagicle Screen Recording engine is a client/server application, where three components should be installed inside Imagicle UC Suite actual/virtual server:

  • Screen Logger Configurator Service
  • Screen Logger Screen Server
  • Screen Logger Management Studio

Latest installation wizards are available to download from our official packages page.

Please proceed with the packages installation on Imagicle UC Suite, following the order highlighted in this KB.

Note: Imagicle Screen Recording Engine comes with an evaluation license lasting 90 days, allowing to enable up to three workstations to screen capture.

Screen Logger Configurator Service

Run the relevant .msi installer and just follow the wizard until the end.

As highlighted in Installation Notes, please configure this service to automatically restart upon failure.

Screen Logger Screen Server

Run the relevant .msi installer and, when prompted, please fill "Configurator Name" with Imagicle UC Suite FQDN or IP address. If Screen Server is co-located inside Imagicle UC Suite, you can also enter "localhost".

As highlighted in Installation Notes, please configure this service to automatically restart upon failure.

Please leave the default Configuration Port to 4489, as below sample:

Screen Logger Management Studio

Run the relevant .exe installer as Administrator and just follow the wizard until the end.

Once installation is accomplished, please run the Management Studio and connect to Screen Logger Configuration Server by adding relevant FQDN (localhost, if co-located in UC Suite) or IP. Please leave the default port 4493.

Once connected, you must enter the admin credentials to login. Initially, they are Demo/Demo.

Please select Settings ⇒ Users ⇒ New User. See below screenshot:

Within "Authentication" tab, please enter the credentials for the Administrator user. We suggest to enter admin/admin. Then click on "User Profile" tab:

Select "Administrator" profile from pull-down menu and hit "Apply Changes" button.

Now select Settings ⇒ Options ⇒ Workstation and configure the "Default Codec" to VP80 and make sure that "Enable Data Encryption" flag is unchecked. See below screenshot sample:

Now it is required to configure the data retention. Please select Server FQDN from left pane ⇒ Summary and hit "Change" button to popup Data Retention window. Please set value to 7 days and hit Save:

Imagicle FQDN is still under "Unassigned" Screen Loggers. To move it above, inside "ScreenLogger System", right-click on server's FQDN and select "Assign to System":

Imagicle Screen Recording Engine is now ready to accept screen capture requests coming from users' workstations. All recorded screens are saved as .webm video files into the folder: C:\EkisaServerData\<server hostname> where <hostname> corresponds to Imagicle FQDN, as available into "ScreenLogger System" network view. Please consider this is just a temporary storage location, because recorded screens are eventually encrypted and copied to usual Call Recording folders, as per "Data Management" setup in Imagicle UC Suite's Global Settings.

To evaluate required HDD space to store recorded screen videos, Imagicle provides a Storage Calculator.

Licensing

Once the 90-day evaluation period has expired, the Screen Logger Configurator service keeps on operating if a valid license has been registered. The Screen Logger licensing mechanism operates on the server where Screen Logger Configurator service is running.

Create License Request File

In Screen Logger Management Studio, Please login as administrator and select "Licensing" tab.

Click on "Create License Request File" and provide a destination path where the file can be saved.

Send the "License Request File" to Imagicle Support via email, stating the purchase order reference number as well.

Import License Activation File

Imagicle Support returns you via email a "License Activation File". The filename format is: EkisaLicenceActivation [MachineID] [Date].xml. Save this file to any convenient location.

In Screen Logger Management Studio, select "Licensing" tab and then click on "Register Licence Activation File" and provide the source path where above XML file has been stored. If successful, a message should appear to request a Configuration service restart. See below screenshot sample:

Verify New Licenses

Login to Screen Logger Management Studio as administrator and select "Licensing". The new or updated licensing information should be displayed, as below screenshot sample:

Network Ports Usage

To properly configure your firewall "allow" list, please consider that Imagicle Screen Recording is using the following default ports between Imagicle UC Suite and enabled users' workstations:

  • Video Broadcast: UDP 4490
  • Configuration:      TCP 4489
  • Recording:           TCP 4488
  • Playback:             TCP 4487
  • HTTP Playback:   TCP 4479 (only required when using Screen Logger Screen Player)
  • HTTPS Playback: TCP 4480 (only required when using Screen Logger Screen Player)

For those scenarios where Screen Logger Workstations can't resolve Screen Logger Server FQDN, you can manually modify Screen Logger Server announced FQDN by editing the following file: C:\ProgramData\Ekisa\Server\Server.ini

Please add the following setting:

[Config]

SystemName=<ScreenServer-FQDN>

Once updated, please restart Screen Logger Server

Please remember that Screen Logger Workstations should resolve both Screen Logger Configurator Service and Screen Server FQDNs. Typically, they are the same.

Screen Logger server components update

When a new software version is released, you need to update all Screen Logger sever components:

  1. Uninstall any previous Screen Logger server applications prior to installation of the new ones.
  2. Install ScreenLoggerConfiguratorServiceInst.msi first.
  3. Then proceed with ScreenLoggerScreenServerInst.msi
  4. Finally, install ScreenLoggerManagementStudioInst.msi.

Please note:

  • Existing configurations are retained.
  • After having updated Screen Logger server components, you can update Screen Logger Workstation component at your own pace, with no rush. Users can temporarily keep using the old version without problems.

Screen Recording Engine - Workstation components

Each Call Recording user who wishes to leverage Screen Recording feature must install the following component on own PC workstation:

  • Screen Logger Workstation
  • Screen Logger Screen Player

Latest installation wizards are attached to this KB article, inside "Imagicle Screen Recorder - PC Packages.zip" file.

Screen Logger Workstation

Run the relevant .msi installer and, when prompted, please fill "Configurator Name" with the same instance FQDN or IP configured into Screen Logger Screen Server. Do not enter "localhost" here.

Please leave the default Configuration Port to 4489, as below sample:

Please repeat this installation in all user's PCs to be enabled for Screen Recording.

If the Desktop Icon feature is enabled on Screen Logger Management Studio, you can monitor actual screen recording activities. See below:

Screen Logger Workstation update

In case Screen Logger Screen Server is updated to latest release, you should also update the workstation component:

  1. Uninstall current Screen Logger Workstation
  2. Run Windows Task Manager and check Ekisa Workstation process is not running 
  3. Go to C:\ProgamData\Ekisa on your hard disk and remove ALL data
  4. Install new Screen Logger workstation by running latest ScreenLoggerWorkstationInst.msi package.

Screen Logger Screen Player

Each user can optionally install this component to playback recorded screens of last seven days, including ongoing sessions. Recorded sessions visibility is dictated by the permission level of the user who logs in to the application with own credentials. See below screenshot sample:

Previous screen recordings are available to download as .webm video files from Imagicle Call Recording Search and Play web page (if authorized by the UC Suite administrator), to be played back using any standard video player.

Once installations are accomplished for all users, relevant workstations immediately contact the Screen Logger Screen Server to notify their availability. At this point, it is up to the Administrator to actually enable them on Imagicle UC Suite.

Enabling users to Screen Recording

Please login to Screen Logger Management Studio with previously configured "admin" credentials:

Management Studio main window appears, where you can find the list of all users and relevant PC workstations listed into left pane's Network view, under "Unassigned" category. See below:

Agent's name comes from user's Windows logon credentials. Workstation name is the PC hostname/FQDN. To enable users, just right-click on each PC's FQDN and select "Assign to System" to move them to above "ScreenLogger System":

Within Summary settings, you can also choose to enable a taskbar icon on workstation PC, showing real-time screen recording status.

Please make sure you have enough Screen Recording Engine static workstation (Users) or dynamic workstation (Channels) licenses to cover all users/PCs.

Each PC workstation and agent listed in Management Studio must have the Default rule added within Rules ⇒ Recording Rules tab. See below sample:

Article ID: 949
Last updated: 17 Nov, 2023
Revision: 7
Views: 505
Print Export to PDF Subscribe Share
This article was:  
Attached files
file Imagicle Call and Screen Recording Channel and Storage Calculator-rev2.xlsx (98 kb)

Prev   Next
Screen Recording UC Suite Settings     Product Integration API