robot

2023.10

false

Robot User Guide

Last updated Oct 25, 2024

PiP - Child Session

The Picture in Picture - Child Session allows you to run attended processes in an isolated Windows session without interrupting your current work.

When a process is started in Picture-in-Picture mode, a new session is spawned. If you run an automation in PiP for the first time, you are asked to authenticate the new session using your Windows credentials.

After the session is created, a preview window appears on your desktop, providing real-time feedback from the process execution. This window can be resized, moved, placed in full screen, or put on top of other windows. You can exit Picture-in-Picture mode at any moment by right-clicking the Picture-in-Picture Windows Taskbar entry and selecting Close Window or simply closing the window. A confirmation dialog appears and choosing to close the PiP window stops the running process.

Note:

The default timeout to start a process in a PiP session is 180 seconds. If the login in the Picture-in-Picture session takes longer than that, a timeout error is thrown. This default timeout can be changed using UIPATH_PIP_SESSION_TIMEOUT environment variable on the machine. When using the Robot in Service-Mode, make sure to set the UIPATH_PIP_SESSION_TIMEOUT variable as a system environment variable and restart the Robot Service.

Admin rights are needed to enable the Picture-in-Picture functionality on the machine. This is needed only the first time Picture-in-Picture is used. Afterwards, the actual process can be started in Picture-in-Picture without elevated privileges.

Controls

The following controls are available for the PiP window:

- Enable this to take control of the PiP session, if this is disabled, your mouse and keyboard only work in the main session.
- Enable this to keep the PiP window on top of other applications even when it's out of focus.
Minimize - Minimizes the PiP window to the main session taskbar without interrupting the process.
Maximize - Maximizes the PiP window.
Close - Closes the PiP window, stops any running process and logs off the PiP session.

The credentials used for Picture in Picture are managed by the Windows Child Session mechanism. For more information, read the Microsoft child sessions documentation.

After PiP is enabled, these credentials are required when a PiP child session is launched until the user logs on again on the machine, or in specific scenarios such as using a smart card or PIN instead of a username/password combination.

Enabling PiP on the Machine

The Picture-in-Picture functionality of the machine can be either enabled through command-line, or manually when starting the PiP session for the first time on the machine.

Method	Command	Description
Manually		The first time you start a Picture-in-Picture session from either Studio or Assistant, you are prompted to enable the PiP functionality on the machine. This requires administrator rights.
Command-line	`UiRobot.exe PiP`	Allows you to enable or disable the Picture-in-Picture functionality on the machine. This setting is applied on the local machine and affects all users and is used for modifying existing installations. It can have the following parameters: `PiP --enable` Enables the Picture-in-Picture functionality of the machine. `PiP --disable` Disables the Picture-in-Picture functionality of the machine. Example: `UiRobot.exe PiP --Enable` Administrator rights are required to execute these commands.
Command-line	`UiPathStudio.msi ENABLE_PIP`	Allows you to enable the Picture-in-Picture functionality of the machine during the UiPath command-line installation. To enable it, use the following parameter: `ENABLE_PIP=1` Example: `UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages ENABLE_PIP=1`

Method

Command

Description

Manually

The first time you start a Picture-in-Picture session from either Studio or Assistant, you are prompted to enable the PiP functionality on the machine. This requires administrator rights.

Command-line

UiRobot.exe PiP

Allows you to enable or disable the Picture-in-Picture functionality on the machine. This setting is applied on the local machine and affects all users and is used for modifying existing installations.

It can have the following parameters:

PiP --enable

Enables the Picture-in-Picture functionality of the machine.

PiP --disable

Disables the Picture-in-Picture functionality of the machine.

Example: UiRobot.exe PiP --Enable

Administrator rights are required to execute these commands.

Command-line

UiPathStudio.msi ENABLE_PIP

Allows you to enable the Picture-in-Picture functionality of the machine during the UiPath command-line installation.

To enable it, use the following parameter:

ENABLE_PIP=1

Example:

UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages ENABLE_PIP=1

Known Issues and Limitations

There are a few things to consider when using the Picture-in-Picture feature:

If you are using a PIN to log into the main Windows session, you are asked for your credentials every time you start a Picture-in-Picture session.
When the Picture-in-Picture session is opened, start-up programs open in the PiP session as well. Because of this, some settings for peripheral devices can be reset to their default values (such as lighting settings for keyboard and mouse).
If you enable the Remote Desktop Session when the prompt appears while running a PiP Process, you need to log out and log back in the main Windows Session for the changes to take effect.
The machine cannot be restarted or shut down while the PiP session is opened as the PiP session needs to be closed beforehand.
Due to Operating System limitations for running Picture-in-Picture, Home Editions of Windows 8 and 10 are not supported.
The clipboard is shared between the PiP session and the main session.
Run as administrator cannot be used in the PiP session.
Only one Picture-in-Picture session can be started at a time.
For a user to start a PiP session, it must be granted Allow Log On Locally permissions.

Microsoft Office automation

Automations that use Microsoft Office resources do not run successfully in Picture-in-Picture if the resources are already open in the main session. In order to make sure that automations run smoothly in PiP, you can do the following:

Close the resource used by Microsoft Office applications from the main session so they can be opened in the PiP session.
Use an InvokeIsolatedWorkflow activity to invoke the part of the automation using Microsoft Office and set its Target Session to Picture-in-Picture from Studio.

Using web browser in PIP sessions

The browser data from a Picture-in-Picture session is saved on the main session by default. If there is an open Google Chrome or Microsoft Edge instance on the main session, it has to use another user profile in the PiP. This is done automatically by the Open Browser activity. We cannot have a specific browser (let's say Chrome) be open with the same user profile both in the PiP session and the Main session at the same time.

However, the mode and location of the browser data can be configured from the Open Browser activity properties.

Setting the UserDataFolderMode property to Automatic allows the browser to use separate user data folders in the main and PiP sessions.

Please note that if you clear the user data from the %LocalAppData%\UiPath\PIP Browser Profiles folder in this mode, the corresponding browser extension needs to be enabled again.

In case you need to use data from the main session (such as cookies or saved passwords), consider setting the UserDataFolderMode property to DefaultFolder. This means that both the main and PiP sessions use the same folder for the browser user data.

Note: When setting the UserDataFolderMode to DefaultFolder the browser only works in one session at a time. If the browser is opened in the main session, it does not work in the PiP session. This is because the same browser profile cannot be used in two simultaneously sessions.

Note: Target Session and UserDataFolderMode are properties that can only be modified in Studio. Projects developed in StudioX need to opened in Studio to alter these properties.

Setting the UserDataFolderMode property to CustomFolder allows you to specify different user data folders for the main and PiP sessions.

PiP Requires login every time

Based on your environment, certain Windows policies might cause the PiP session to request a login every time it starts.

For example, the following setting set to Disabled triggers the PiP window to ask for credentials every time it starts:

Local Group Policy\Computer Configuration\Administrative Templates\System\Credential Delegation\Allow delegating default credentials

This also happens when Windows Business Hello PIN is used. PIN authentication only works the first time a PiP session is launched. After that, the PiP session can only be authenticated using username and password.

Smartcard Authentication

If your environment requires logon with a smartcard, the following policy should not be set to Enabled:

Computer Configuration\Administrative Templates\Windows Components\Remote Desktop Services\Remote Desktop Session Host\Device and Resource Redirection\Do not allow smart card device redirection

Workflow takes a long time to start in PiP

When launching a process in PiP for the first time, it takes longer than usual until the actual execution starts. This happens because the PiP session has to start all its Windows processes and start-up programs.

Recommendation: Launch a PiP session when starting the machine and keep it open throughout the day. This uses less resources than launching a new PiP session for every process.

PiP session does not start

Some Windows policies can restrict the PiP session from starting. To avoid this, the user launching a PiP session must be a part of the following policies:

Computer Configuration\Windows Settings\Security Settings\Local Policies\User Rights Assignment\Allow Log On Locally
Computer Configuration\Windows Settings\Security Settings\Local Policies\User Rights Assignment\Access this computer from the network
- Important: This policy is needed if Device Guard is enabled on the robot machine. This means that both Kernel DMA Protection is turned on, and Local Group Policies enforce Device Guard on the machine.
  
  In the scenario where Device Guard is enabled but the Access this computer from the network is disabled, when trying to launch a PiP session, the following error is displayed: "ChildSession Disconnected: The system administrator has restricted the types of logon (network or interactive) that you may use. For assistance, contact your system administrator or technical support., Reason: 4871, ExtendedReason exDiscReasonNoInfo"

Note: We are currently investigating to find other policies that can affect the PiP functionality.

VPN client not working in PiP

When VPN clients are used in conjunction with PiP, there are some situations in which conflicts may occur. For example, if the VPN clients are set to start when the user logs in, when PiP starts, another instance of the VPN client is started. This causes a conflict between the two sessions, since the VPN client is set to run a single instance per user.

To resolve these scenarios, we have compiled a list of the most common VPN providers with their particularities, plus resolutions for the known issues that may occur.

Cisco Anyconnect

Observed Behavior

When the Cisco Anyconnect client is running on the user machine and a PiP session is launched, another Cisco Anyconnect client is started in the PiP session.

Cause

The Cisco VPN server is set to accept one session per user at a time. When the PiP session starts, Cisco Anyconnect disconnects the VPN in the main session and throws an error in the PiP session.

This shuts down the user's VPN connection, leaving the user unable to access services that require a VPN connection.

Resolution

Do not set the VPN client to start automatically at Windows start-up. This stops the VPN client from starting a new connection when the PiP session starts and tunnels the PiP traffic through the main Windows session.

Zscaler

Observed Behavior

When the PiP session is started, another Zscaler client is launched in the PiP session. This causes the Zscaler client to disappear from the main Windows session. Everything works as expected until the user closes the PiP session. When the PiP session is closed, the Zscaler client remains in a limbo state and the user must sign out and sign in again, or restart the machine to open the Zscaler.

Cause

Zscaler is investigating this issue on their side.

Resolution

Please open up a ticket with the Zscaler support team.

Pulse secure

Observed Behavior

When a PiP session is started, the user is disconnected from the VPN.

Cause

The Pulse secure client cannot handle two Windows sessions for the same user.

Resolution

We recommend opening a ticket with Pulse Secure team.

Palo Alto Global Protect

When PiP starts, the GUI shows the user disconnected from the VPN in both sessions. But the PiP session is still connected to the VPN.

Resolution

We recommend opening a ticket with Palo Alto team.

PIP and Windows servers

In a scenario where multiple users are connected at the same time to a Windows Server, only one PIP session can be launched on the machine. This means only one PiP session can be opened on a single machine, regardless of which user or session type was used to open the PiP session.