Collaboration

PCoIP Ultra Collaboration enables a PCoIP session user to share their session with multiple remote collaborators using Anyware Software Clients.

Up to 5 collaborators can join an ongoing PCoIP session using the same invitation. The maximum number of collaborators can be reduced by configuring the agent.

While connected, all collaborators can view and hear the session owner's screens and audio, and see the controlling collaborator's mouse movements. If permitted by the session owner, they can also share control of the session owner's keyboard and mouse using input control.

During a collaboration session, all of the session owner's desktop screens may be shared depending on the session owner's Anyware Software client display settings. See Understanding Display Behavior for more information.

Collaboration Requirements

PCoIP Ultra Collaboration is supported by all Anyware agents. Anyware Software clients that support PCoIP Ultra can participate in collaboration sessions (all Anyware Software clients 23.04 and higher meet this requirement).

Some collaboration features have specific version requirements for Anyware agents and Anyware Software clients; these are noted below.

Feature Version Requirements

PCoIP Ultra Collaboration features depend on coordinated updates in Anyware agents and Anyware clients, so review these requirements carefully to ensure the features you need are supported by your system. We strongly recommend using the latest versions of both Anyware agent and Anyware client.

Network Requirements

Each collaborator connection requires a separate UDP port. These ports are assigned in a range that begins with the configured UDP port (by default, 64172), and increments with each additional collaborator. All ports in this range must be open, both at the cloud provider network level and the local firewall at the host.

For example, using the default configuration and hosting three collaborators, the system would require inbound UDP ports 64172, 64173, and 64174 to be open.

You can change the starting port number if desired. If you change the configured starting UDP port, adjust these ranges and ensure your host firewall configuration allows traffic on the new ports.

For direct connections, or brokered connections that do not use a Security Gateway, each collaborator's Anyware client must be able to reach these ports. For brokered connections using a Security Gateway, only the Security Gateway must be able to reach them.

Enabling Collaboration

PCoIP Ultra Collaboration is enabled, disabled, and configured on the Anyware agent machine. It is disabled by default, and must be enabled by activating both PCoIP Ultra and Collaboration on the remote desktop.

The following steps apply to the session owner's desktop machine.

To enable PCoIP Ultra Collaboration:

1. Open /etc/pcoip-agent/pcoip-agent.conf in a text editor.

2. If PCoIP Ultra is not already enabled, enable it by adding a new line in the text editor, and configuring the PCoIP Ultra offload mode:

   PCoIP Ultra mode	Supported by	Add a line with this value
   CPU Offload	Standard Agents, Graphics Agents	pcoip.ultra = 1
   GPU Offload	Graphics Agents	pcoip.ultra = 2
   Auto Offload	Graphics Agents	pcoip.ultra = 3

3. Add a new line enabling collaboration:

   pcoip.enable_collaboration = 1
   

4. Optional: To enable Collaboration Input Control if desired, stay in the text editor and follow the instructions in Enabling Input Control below.

5. Optional: You can change the UDP starting port if needed (the default starting port is UDP 64172). To change the collaboration port number, add a new line specifying the new value:

   pcoip.collaboration_udpport = <new_collaborator_port>
   

   ...where <new_collaborator_port> is your new starting port number.

6. Save the file and exit the editor.

7. Restart the Anyware agent service:

   sudo systemctl restart pcoip
   

See Configuration Guide - Configurable Settings for more detailed information on setting configuration values.

Input Control

Collaborator input control allows collaborators to use their own mice and keyboards to control the session owner's desktop. This feature is disabled by default, and must be enabled on the Anyware agent before it is available.

Enabling Input Control

Input control is disabled by default, and the option to give collaborators input control cannot be selected.

To use Input Control, enable it on the Anyware agent. This change takes effect on the next PCoIP session:

1. Using a text editor, open the following file:

   /etc/pcoip-agent/pcoip-agent.conf
   

2. Add a new line enabling input control:

   pcoip.enable_collaboration_input_control = 1
   

3. Optional: Provide a custom input control timeout value (specified in milliseconds; 3000ms is 3 seconds):

   pcoip.collaboration_input_control_timeout <timeout_value_in_ms>
   

4. Save the file and exit the text editor.

Disabling Input Control

If Input Control has been enabled and you wish to disable it again:

1. Using a text editor, open the following file:

   /etc/pcoip-agent/pcoip-agent.conf
   

2. Disable input control:

   pcoip.enable_collaboration_input_control = 0
   

3. Save the file and exit the text editor.

Configuring Collaboration

Changing the Collaboration Starting Port

The default starting UDP Port for collaborator sessions is 64172. You can change this value if needed. Remember that you must also open a range of UDP ports that begin with this value to accommodate all of your collaborators; see Network Requirements for examples.

To change the Collaboration session port:

1. Open /etc/pcoip-agent/pcoip-agent.conf in a text editor.

2. Create new config entry specifying the new starting UDP port number to use:

   pcoip.collaboration_udpport = <new_collaborator_port>
   

3. Save the file and exit the text editor.

4. Restart the Anyware agent service:

   sudo systemctl restart pcoip
   

Changing the Maximum Number of Collaborators

PCoIP Ultra Collaboration supports up to 5 collaborators on the same PCoIP session. You can further limit the number of allowed collaborators by changing the maximum collaborators setting to a value from 1-5. By default, the system allows 5 collaborators.

To Change the Maximum Number of Collaborators:

1. Open /etc/pcoip-agent/pcoip-agent.conf in a text editor.

2. Create a new entry, replacing <maximum number of collaborators> with your desired value from 1-5:

   pcoip.max_collaborators = <maximum number of collaborators>
   

3. Save the file and exit the editor.

4. Restart the Anyware agent service:

   sudo systemctl restart pcoip
   

Changing the Input Control Timeout Value

Input control is released and made available to other collaborators by idling all input devices for a brief period. By default, this control timeout is 3 seconds (3000ms). You can change this value by configuring the Anyware agent machine as follows:

1. Using a text editor, open the following file:

   /etc/pcoip-agent/pcoip-agent.conf
   

2. Provide a custom input control timeout value (specified in milliseconds; 3000ms is 3 seconds):

   pcoip.collaboration_input_control_timeout = <timeout_value_in_ms>
   

3. Save the file and exit the text editor.

4. Restart the Anyware agent service:

   sudo systemctl restart pcoip
   

Sharing Your Session With Collaborators