en-US/UiPathOrch-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Disable-OrchPersonalWorkspace</command:name> <maml:description> <maml:para>Disables personal workspace for a user on UiPath Orchestrator.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>OrchPersonalWorkspace</command:noun> </command:details> <maml:description> <maml:para>Disables the personal workspace feature for the specified user on UiPath Orchestrator. This cmdlet updates the user settings by setting the MayHavePersonalWorkspace property to False.</maml:para> <maml:para>After disabling the personal workspace, the cmdlet automatically clears the in-memory cache to reflect the changes.</maml:para> <maml:para>The -UserName parameter supports tab completion. Press [Ctrl+Space] or [Tab] to see available tenant users. The -UserName completions are dynamically populated from actual user data on the target drives.</maml:para> <maml:para>This is a script function (external help file: UiPathOrch-Help.xml) that wraps the Update-OrchUser cmdlet.</maml:para> <maml:para>Primary Endpoint: GET /odata/Users, PUT /odata/Users({userId})</maml:para> <maml:para>OAuth required scopes: OR.Users</maml:para> <maml:para>Required permissions: Users.View, Users.Edit</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-OrchPersonalWorkspace</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name of the target drives. If not specified, the current drive is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user name of the user to disable personal workspace for. Accepts wildcard patterns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name of the target drives. If not specified, the current drive is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user name of the user to disable personal workspace for. Accepts wildcard patterns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe user names to this cmdlet via the UserName property.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para>This cmdlet does not produce output directly. It calls Update-OrchUser to update user settings.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet sets MayHavePersonalWorkspace to False for the specified user. Unlike Enable-OrchPersonalWorkspace, it does not modify the MayHaveRobotSession setting. The cache is automatically cleared after the operation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Disable personal workspace for a user ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Disable-OrchPersonalWorkspace ytsuda@gmail.com ```</maml:para> <maml:para></maml:para> <maml:para>Disables the personal workspace for the user ytsuda@gmail.com on the current drive.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Disable personal workspace on a specific drive ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Disable-OrchPersonalWorkspace ytsuda@gmail.com -Path Orch1: ```</maml:para> <maml:para></maml:para> <maml:para>Disables the personal workspace for the specified user on the Orch1: drive.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Preview changes with WhatIf ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Disable-OrchPersonalWorkspace ytsuda@gmail.com -WhatIf ```</maml:para> <maml:para></maml:para> <maml:para>Shows what would happen if the cmdlet runs without actually making changes.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-OrchUserAttended</command:name> <maml:description> <maml:para>Disables the attended robot session for users.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>OrchUserAttended</command:noun> </command:details> <maml:description> <maml:para>Disables the attended robot session (MayHaveRobotSession) for specified users in UiPath Orchestrator. This is a convenience wrapper around Update-OrchUser that sets -MayHaveRobotSession to False for the specified users.</maml:para> <maml:para>When a user has MayHaveRobotSession disabled, they are not allowed to run attended automations using UiPath Assistant on their machine.</maml:para> <maml:para>The -UserName parameter supports wildcards to disable the attended session for multiple users at once. Tab completion dynamically suggests usernames from the target tenant.</maml:para> <maml:para>The -UserName and -Path parameters support tab completion. Press [Ctrl+Space] or [Tab] to see available values.</maml:para> <maml:para>Primary Endpoint: GET /odata/Users, PUT /odata/Users({userId})</maml:para> <maml:para>OAuth required scopes: OR.Users</maml:para> <maml:para>Required permissions: Users.View, Users.Edit</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-OrchUserAttended</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target Orch: drives. If not specified, the current drive is targeted. Tab completion suggests available Orch: drives.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the usernames of users to disable the attended robot session for. This is a mandatory parameter. Supports wildcards. Tab completion dynamically suggests usernames from the target tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target Orch: drives. If not specified, the current drive is targeted. Tab completion suggests available Orch: drives.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the usernames of users to disable the attended robot session for. This is a mandatory parameter. Supports wildcards. Tab completion dynamically suggests usernames from the target tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe a single username to this cmdlet via the UserName property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe usernames and path values to this cmdlet via the UserName and Path properties.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para>This cmdlet does not produce output. The user is updated via Update-OrchUser internally.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is a PowerShell script function that wraps Update-OrchUser with -MayHaveRobotSession False. Each specified user is updated individually in a loop. The function also passes all bound parameters via splatting (@PSBoundParameters). Users are tenant-scoped entities. Navigate to the root of an Orch: drive or use -Path to specify target drives.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Disable attended robot for a specific user ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Disable-OrchUserAttended ytsuda@gmail.com ```</maml:para> <maml:para></maml:para> <maml:para>Disables the attended robot session for the user "ytsuda@gmail.com". The -UserName parameter is positional (position 0) so the parameter name can be omitted.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Disable attended robot for multiple users with a wildcard ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Disable-OrchUserAttended ytsuda* ```</maml:para> <maml:para></maml:para> <maml:para>Disables the attended robot session for all users whose username starts with "ytsuda".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Disable attended robot from a specific drive ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Disable-OrchUserAttended -Path Orch1:\ -UserName ytsuda+c@gmail.com ```</maml:para> <maml:para></maml:para> <maml:para>Disables the attended robot session for "ytsuda+c@gmail.com" on the Orch1 tenant. When -Path uses an absolute path, the command can be run from any location.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: Preview changes with -WhatIf ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Disable-OrchUserAttended ytsuda* -WhatIf ```</maml:para> <maml:para></maml:para> <maml:para>Shows which users would have their attended robot session disabled without actually making changes.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-OrchPersonalWorkspace</command:name> <maml:description> <maml:para>Enables personal workspace for a user on UiPath Orchestrator.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>OrchPersonalWorkspace</command:noun> </command:details> <maml:description> <maml:para>Enables the personal workspace feature for the specified user on UiPath Orchestrator. This cmdlet updates the user settings to allow them to have a personal workspace and robot session by setting the MayHavePersonalWorkspace and MayHaveRobotSession properties to True.</maml:para> <maml:para>After enabling the personal workspace, the cmdlet automatically clears the in-memory cache to reflect the changes.</maml:para> <maml:para>The -UserName parameter supports tab completion. Press [Ctrl+Space] or [Tab] to see available tenant users. The -UserName completions are dynamically populated from actual user data on the target drives.</maml:para> <maml:para>This is a script function (external help file: UiPathOrch-Help.xml) that wraps the Update-OrchUser cmdlet.</maml:para> <maml:para>Primary Endpoint: GET /odata/Users, PUT /odata/Users({userId})</maml:para> <maml:para>OAuth required scopes: OR.Users</maml:para> <maml:para>Required permissions: Users.View, Users.Edit</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-OrchPersonalWorkspace</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name of the target drives. If not specified, the current drive is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user name of the user to enable personal workspace for. Accepts wildcard patterns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the name of the target drives. If not specified, the current drive is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user name of the user to enable personal workspace for. Accepts wildcard patterns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe user names to this cmdlet via the UserName property.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para>This cmdlet does not produce output directly. It calls Update-OrchUser to update user settings.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet sets both MayHavePersonalWorkspace and MayHaveRobotSession to True for the specified user. The cache is automatically cleared after the operation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Enable personal workspace for a user ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Enable-OrchPersonalWorkspace ytsuda@gmail.com ```</maml:para> <maml:para></maml:para> <maml:para>Enables the personal workspace for the user ytsuda@gmail.com on the current drive.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Enable personal workspace on a specific drive ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Enable-OrchPersonalWorkspace ytsuda@gmail.com -Path Orch1: ```</maml:para> <maml:para></maml:para> <maml:para>Enables the personal workspace for the specified user on the Orch1: drive.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Preview changes with WhatIf ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Enable-OrchPersonalWorkspace ytsuda@gmail.com -WhatIf ```</maml:para> <maml:para></maml:para> <maml:para>Shows what would happen if the cmdlet runs without actually making changes.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-OrchUserAttended</command:name> <maml:description> <maml:para>Enables the attended robot session for users.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>OrchUserAttended</command:noun> </command:details> <maml:description> <maml:para>Enables the attended robot session (MayHaveRobotSession) for specified users in UiPath Orchestrator. This is a convenience wrapper around Update-OrchUser that sets -MayHaveRobotSession to True for the specified users.</maml:para> <maml:para>When a user has MayHaveRobotSession enabled, they are allowed to run attended automations using UiPath Assistant on their machine.</maml:para> <maml:para>The -UserName parameter supports wildcards to enable the attended session for multiple users at once. Tab completion dynamically suggests usernames from the target tenant.</maml:para> <maml:para>The -UserName and -Path parameters support tab completion. Press [Ctrl+Space] or [Tab] to see available values.</maml:para> <maml:para>Primary Endpoint: GET /odata/Users, PUT /odata/Users({userId})</maml:para> <maml:para>OAuth required scopes: OR.Users</maml:para> <maml:para>Required permissions: Users.View, Users.Edit</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-OrchUserAttended</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target Orch: drives. If not specified, the current drive is targeted. Tab completion suggests available Orch: drives.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the usernames of users to enable the attended robot session for. This is a mandatory parameter. Supports wildcards. Tab completion dynamically suggests usernames from the target tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target Orch: drives. If not specified, the current drive is targeted. Tab completion suggests available Orch: drives.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the usernames of users to enable the attended robot session for. This is a mandatory parameter. Supports wildcards. Tab completion dynamically suggests usernames from the target tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe a single username to this cmdlet via the UserName property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe usernames and path values to this cmdlet via the UserName and Path properties.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para>This cmdlet does not produce output. The user is updated via Update-OrchUser internally.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is a PowerShell script function that wraps Update-OrchUser with -MayHaveRobotSession True. Each specified user is updated individually in a loop. Users are tenant-scoped entities. Navigate to the root of an Orch: drive or use -Path to specify target drives.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Enable attended robot for a specific user ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Enable-OrchUserAttended ytsuda@gmail.com ```</maml:para> <maml:para></maml:para> <maml:para>Enables the attended robot session for the user "ytsuda@gmail.com". The -UserName parameter is positional (position 0) so the parameter name can be omitted.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Enable attended robot for multiple users with a wildcard ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Enable-OrchUserAttended ytsuda* ```</maml:para> <maml:para></maml:para> <maml:para>Enables the attended robot session for all users whose username starts with "ytsuda".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Enable attended robot from a specific drive ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Enable-OrchUserAttended -Path Orch1:\ -UserName ytsuda+c@gmail.com ```</maml:para> <maml:para></maml:para> <maml:para>Enables the attended robot session for "ytsuda+c@gmail.com" on the Orch1 tenant. When -Path uses an absolute path, the command can be run from any location.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: Preview changes with -WhatIf ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Enable-OrchUserAttended ytsuda* -WhatIf ```</maml:para> <maml:para></maml:para> <maml:para>Shows which users would have their attended robot session enabled without actually making changes.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Find-OrchFolderNoUserAssigned</command:name> <maml:description> <maml:para>Finds folders that have no user assignments.</maml:para> </maml:description> <command:verb>Find</command:verb> <command:noun>OrchFolderNoUserAssigned</command:noun> </command:details> <maml:description> <maml:para>Recursively checks all folders under a specified path and returns folders where no users are assigned. By default, only direct user assignments are considered. Users inherited from parent folders are not counted unless the -IncludeInherited switch is specified.</maml:para> <maml:para>This cmdlet is useful for identifying folders that may need user assignments or that can be cleaned up.</maml:para> <maml:para>This is a script function (external help file: UiPathOrch-Help.xml) that uses Get-ChildItem (dir) with -Recurse to enumerate folders, and Get-OrchFolderUser to check user assignments for each folder.</maml:para> <maml:para>Primary Endpoint: GET /odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={folderId},includeInherited={bool})</maml:para> <maml:para>OAuth required scopes: OR.Folders or OR.Folders.Read</maml:para> <maml:para>Required permissions: SubFolders.View, Users.View</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-OrchFolderNoUserAssigned</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the folder where the search should start.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeInherited</maml:name> <maml:description> <maml:para>When specified, the cmdlet considers users inherited from parent folders as part of the user assignments. Without this switch, only direct user assignments are checked. A folder with only inherited users (no direct assignments) is returned when this switch is not used, but excluded when this switch is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeInherited</maml:name> <maml:description> <maml:para>When specified, the cmdlet considers users inherited from parent folders as part of the user assignments. Without this switch, only direct user assignments are checked. A folder with only inherited users (no direct assignments) is returned when this switch is not used, but excluded when this switch is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the folder where the search should start.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <dev:name>UiPath.PowerShell.Entities.Folder</dev:name> </dev:type> <maml:description> <maml:para>Returns Folder objects for each folder that has no user assignments.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>By default, users inherited from parent folders are ignored. If the -IncludeInherited switch is provided, inherited users will be included in the check.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Find folders without direct user assignments ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Find-OrchFolderNoUserAssigned Orch1:\ ```</maml:para> <maml:para></maml:para> <maml:para>Recursively checks all folders under the Orch1:\ root and lists those without direct user assignments.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Find folders without any user assignments including inherited ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Find-OrchFolderNoUserAssigned Orch1:\ -IncludeInherited ```</maml:para> <maml:para></maml:para> <maml:para>Recursively checks all folders under the Orch1:\ root and lists those without any user assignments, including users inherited from parent folders.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-OrchJobVideo</command:name> <maml:description> <maml:para>Gets jobs that have video recordings attached.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>OrchJobVideo</command:noun> </command:details> <maml:description> <maml:para>Gets jobs that have video recordings from UiPath Orchestrator. This function filters jobs from the last week that have the HasVideoRecorded property set to true, returning only process-type jobs with attached video recordings.</maml:para> <maml:para>This is a convenience wrapper around Get-OrchJob that applies the following filters: -ProcessType Process, -Last Week, and HasVideoRecorded -eq $true.</maml:para> <maml:para>Primary Endpoint: GET /odata/Jobs</maml:para> <maml:para>OAuth required scopes: OR.Jobs or OR.Jobs.Read</maml:para> <maml:para>Required permissions: Jobs.View</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OrchJobVideo</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target folders. If not specified, the current folder is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Includes the target folder and all its subfolders in the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>First</maml:name> <maml:description> <maml:para>Gets only the specified number of jobs. Enter the number of jobs to get.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.UInt64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Skips the specified number of jobs and then gets the remaining jobs. Enter the number of jobs to skip.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.UInt64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>First</maml:name> <maml:description> <maml:para>Gets only the specified number of jobs. Enter the number of jobs to get.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.UInt64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target folders. If not specified, the current folder is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Includes the target folder and all its subfolders in the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Skips the specified number of jobs and then gets the remaining jobs. Enter the number of jobs to skip.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.UInt64</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe folder paths to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>UiPath.PowerShell.Entities.Job</dev:name> </dev:type> <maml:description> <maml:para>Returns Job objects that have video recordings attached, with properties including HasVideoRecorded set to true.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is a PowerShell function that wraps Get-OrchJob with the filters -ProcessType Process, -Last Week, and HasVideoRecorded -eq $true.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Get jobs with video recordings ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\Shared> Get-OrchJobVideo ```</maml:para> <maml:para></maml:para> <maml:para>Gets all jobs with video recordings from the last week in the current folder.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Get jobs with video recordings recursively ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Get-OrchJobVideo -Recurse ```</maml:para> <maml:para></maml:para> <maml:para>Gets all jobs with video recordings from the last week across all folders.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Get the first 10 jobs with video recordings ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\Shared> Get-OrchJobVideo -First 10 ```</maml:para> <maml:para></maml:para> <maml:para>Gets the first 10 jobs with video recordings from the last week in the current folder.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-OrchTestDataQueueItemTable</command:name> <maml:description> <maml:para>Gets test data queue items and displays them in a formatted table.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>OrchTestDataQueueItemTable</command:noun> </command:details> <maml:description> <maml:para>Gets items from test data queues and displays them in a formatted table view. This function is a wrapper around Get-OrchTestDataQueueItem that expands the JSON content of each item into individual columns, making it easier to view structured test data.</maml:para> <maml:para>The output is grouped by test data queue path. Each group displays the queue name followed by a table showing the Id, IsConsumed status, and all data columns parsed from the JSON content.</maml:para> <maml:para>Primary Endpoint: (none)</maml:para> <maml:para>OAuth required scopes: (none)</maml:para> <maml:para>Required permissions: (none)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OrchTestDataQueueItemTable</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target folder. If not specified, the current folder is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Includes the target folder and all its subfolders in the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target folder. If not specified, the current folder is targeted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Includes the target folder and all its subfolders in the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>You can pipe a folder path to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para>This cmdlet outputs formatted table data to the console. Each test data queue is displayed with its items in a table that includes Id, IsConsumed, and all columns parsed from the JSON content.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is a PowerShell function that wraps Get-OrchTestDataQueueItem and formats the output using Format-Table for improved readability.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Display all test data queue items as a table ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\root> Get-OrchTestDataQueueItemTable ```</maml:para> <maml:para></maml:para> <maml:para>Gets all test data queue items from the current folder and displays them in a formatted table grouped by queue.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: Display test data queue items from a specific folder ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Get-OrchTestDataQueueItemTable Orch1:\root ```</maml:para> <maml:para></maml:para> <maml:para>Gets all test data queue items from the root folder on Orch1 and displays them in a formatted table.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Display test data queue items recursively ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Orch1:\> Get-OrchTestDataQueueItemTable -Recurse ```</maml:para> <maml:para></maml:para> <maml:para>Gets all test data queue items from the current folder and all its subfolders, displaying them in formatted tables grouped by queue.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |