ScreenAgent for Mac

ScreenAgent NICE ScreenAgent is a service that runs on agent desktops that require screen recording. is available if you have CXone Recording Advanced and a screen recording license.

Install ScreenAgent NICE ScreenAgent is a service that runs on agent desktops that require screen recording. on computers to record or monitor activity on an agent's screen during an interaction. ScreenAgent runs in the background and automatically records according to the recording policies. Supervisors and evaluators can also monitor an agent’s activity during an interaction.

You can install ScreenAgent on agents' computers with Mac operating system. Make sure you're using ScreenAgent version 2.1.75 and later. The supported Mac OS versions are 10.15 macOS Catalina, 11 macOS Big Sur, and later.

Keep in mind:

• ScreenAgent on Mac OS supports up to three screens recordings.

• ScreenAgent on Mac OS supports screen monitoring differently for desktops and laptops.

  • Mac desktops—Supports up to three screens.

  • Mac laptops—Supports up to three screens if the laptop screen is closed. When the laptop screen is open and it's not the main screen, the ScreenAgent captures all the external screens (up to three). The laptop screen will not be captured.

• After successful installation, you need to manually grant permission to record screen.

For a list of features added to previous ScreenAgent releases, see ScreenAgent: Cumulative Release Notes.

Prerequisites

Before starting installing ScreenAgent, make sure to:

1. Check the Connectivity Requirements. Keep in mind, ScreenAgent doesn't record if your firewall generates self-signed certificates or strips request headers from HTTPS packets.

2. Check the agent's computer configuration.

   Agent computer requirements

   • One of the softphone solutions for agents:

     • CXone Agent.

     • Salesforce Agent softphone installed on the same computer as ScreenAgent.

     • MAX softphone.

   • Port 31322 open. This port is only used for internal communication between ScreenAgent and /MAX/CXone Agent/Salesforce Agent softphone on the agent's computer.

3. Make sure the user who is installing ScreenAgent (for example, the admin) has Admin privileges on the agent's computer.

4. Make sure the user who is installing ScreenAgent (for example, the admin) has these CXone permissions:

   • Can access support downloads: On—This allows you to access the Supports - Downloads page.

   • Access Key: Create—This is to manage access keys for your organization.

5. Follow the below steps in given order to generate an access key for ScreenAgent. You can use the same access key for installing ScreenAgent on all agents' computers in your tenant.

   The access key receives all of the permissions of the CXone user who generates it. If this user is an administrator, then anyone with the access key would have administrator privileges. So for security reasons, first create a CXone user and role for ScreenAgent, and then generate the key with the ScreenAgent user.

   1. Create a role for the ScreenAgent service:

      1. Click the app selector and select Admin.

      2. Go to Security > Roles and Permissions.

      3. Click New Role.

      4. Give a name for the role, such as ScreenAgent access key.

      5. Remove all permissions for the role, except Access Key and My Access Key.

      6. Save & Activate the profile.

   2. Create an employee for the ScreenAgent service:

      1. Click the app selector and select Admin.

      2. Click Employees.

      3. Click New Employee.

      4. Give a name for the employee, such as ScreenAgent.

      5. From the Primary Role drop-down list, select the ScreenAgent access key role you just created.

      6. On the General tab, clear all the attributes.

      7. Create the ScreenAgent employee. You can generate access keys only after you create the account.

   3. Open the ScreenAgent employee again and go to the Security tab. Click Add access key to generate an access key.

   4. Copy both the Access Key ID and Secret Access Key and save them somewhere safe. If you don't copy the Secret Access Key or if you lose it, you'll need to create a new one. Use this access key ID and secret access key when installing ScreenAgent on all agents' computers.

   5. Activate the ScreenAgent employee account by clicking the Activate Account button in the activation email.

6. Download the ScreenAgent:

   1. Go to CXone, and log in as a user with the Can access support downloads permission.

   2. Click your Username and select Support and Downloads.

   3. Download the ScreenAgent DMG. Note where you download the DMG to, you'll need the file location later.

Install ScreenAgent

You can install ScreenAgent manually on each agent's computer.

To install ScreenAgent:

1. Make sure all prerequisites are in place.

2. Extract the ScreenAgent-darwin-x64-x.x.x.dmg either via terminal or manually:

   To extract the file via terminal:

   1. In the Terminal app on your Mac, enter the complete path name where you downloaded the DMG file.

   2. To extract the file, type sudo hdiutil attach ScreenAgent-darwin-x64-<enter DMG version, such as 2.1.67>.dmg and press Enter.

   3. To move the file to the Applications folder, type sudo cp -R /Volumes/ScreenAgent/ScreenAgent.app /Applications and press Enter.

   4. Type sudo hdiutil unmount /Volumes/ScreenAgent/ and press Enter.

   To extract the DMG file manually:

   1. Go to the location where you downloaded the DMG file, and double-click the ScreenAgent-darwin-x64-x.x.x.dmg file.

   2. Copy the ScreenAgent folder and paste it in the Applications directory.

3. Step-by-step instructions to install:

   1. Go the Terminal app on your Mac.

   2. Copy and paste the command into the terminal, and edit the parameters listed in the table.

      • If you don't have a web proxy, use this command:

        sh /Applications/ScreenAgent.app/Contents/Resources/install-screen-agent.sh REGION_TYPE=<Enter your region. This is the subdomain (first 3 characters) of the CXone URL (for example: na1, na2, au1, eu1)> ACCESS_KEY_ID=<paste the access key ID> ACCESS_KEY_SECRET=<paste the secret access key>

        Make sure you have the Admin sudo password. This command may prompt you to enter the password.

      • If you have a web proxy, use this command:

        sh /Applications/ScreenAgent.app/Contents/Resources/install-screen-agent.sh REGION_TYPE=<Enter your region. This is the subdomain (first 3 characters) of the CXone URL (for example: na1, na2, au1, eu1)> ACCESS_KEY_ID=<paste the access key ID> ACCESS_KEY_SECRET=<paste the secret access key> WEB_PROXY=<only include if you're using a proxy server to connect to the internet>

        Make sure you have the Admin sudo password. This command may prompt you to enter the password.

      Installation command parameters
      

      Parameter	Description	Example
      ACCESS_KEY_ID	The access key ID created in the Employee account.	ACCESS_KEY_ID=ABCDEF12345====
      ACCESS_KEY_SECRET	The secret access key created in the Employee account.	ACCESS_KEY_SECRET=12345ABCDEF
      REGION_TYPE	The subdomain (first 3 characters) of your CXone URL (for example: na1, na2, au1, eu1).	REGION_TYPE=na1
      WEB_PROXY	Only include this parameter if you’re using a proxy server to connect to the internet. Keep in mind: Host can be hostname or IP. Use http or https according to your proxy settings. Use username and password of the server if it’s set in your proxy settings. For example: http://server_username:server_password@host:port https://server_username:server_password@host:port https://host:port	WEB_PROXY=http://admin:pwd@168.63.76.32:3128     WEB_PROXY=https://proxyserver:8088

4. The log of the installation progress is displayed in the terminal and saved to the installation log file, InstallationLog.txt. The full path is /Applications/ScreenAgent.app/Contents/Resources/InstallationLog.txt.

5. When the installation completes and you're prompted to open ScreenAgent, click Open.

   View image

   

6. When you're prompted to grant screen recording permission in the ScreenAgent application, click Open System Preference.

   View image

   

7. On the System Preferences page, select the ScreenAgent checkbox. A prompt is displayed stating to quit the ScreenAgent to allow it to record the screen. Click Quit Now.

   View image

   

8. Restart the computer or go the Terminal app on your Mac and run the command:

   open /Applications/ScreenAgent.app

9. Make sure the agent has the Can be Recorded (Screen) attribute (in CXone, go to Admin > Employees, and then click on the agent). This attribute is necessary for enabling screen recording, screen monitoring, or both.

10. Record a call and check the ScreenAgent log file. The full path to the ScreenAgent.log file is ~/Library/Application Support/ScreenAgent/ScreenAgent.log. If there were any errors, see Troubleshooting Recordings and FAQs.